API reference

Find exact request and response shapes for every TurfAI endpoint, task type, and schema. This section is the authoritative API reference: read the conventions below, then open the reference pages you need.

Conventions

• Base URL — staging https://apisandbox.turfai.in/api, local http://localhost:1338/api.
• Auth — most endpoints take a user JWT (Authorization: Bearer …). Public surfaces use key headers. See Authentication for the full matrix.
• Strapi shape — list/get responses wrap data in { "data": … } with meta.pagination; writes take { "data": { … } }. Paginate with pagination[page] and pagination[pageSize]; filter and sort with Strapi filters[…] / sort.
• Async execution — workflows, squads, and jobs run asynchronously: you start them, then poll a status endpoint until a terminal status.
• Errors — { "error", "message", "details?" } with standard HTTP codes (400/401/403/404/429/500).

Synced reference

• Comprehensive API documentation — all endpoint groups: Activity, Agent, Agent Conversation, Auth, Chatbot, Collection, Credential, Document, Event Bus, Google OAuth, Job, Prompt, RAG, Webhook, Squad, Workflow Execution, plus the LLM Service and RAG Query Service.
• Task types reference — every workflow task type with config, input, and output schemas.
• Communication standard — the internal job and result message contract between platform services.
• Data schemas — shared object schemas.

Integration guides (synced)

• Webhook integration
• Workflow integration
• Google integrations quick start
• Google OAuth reference
• Testing guide

Downloadable contracts

Machine-readable contracts for the Document/Workflow service (DMS), synced into public/contracts/:

• OpenAPI — /contracts/dms-openapi.yaml
• Postman — /contracts/dms-postman.json

Import the OpenAPI file into your client generator, or the Postman collection into Postman to try endpoints interactively.

Where to go next

• New to the platform? Start with the Quickstart.
• Building something specific? The Guides wire these endpoints into end-to-end examples.