API Reference

Create task.

post
https://app.customgpt.ai/api/v1/projects//tasks

Creates a new V3 agentic task and immediately submits the first prompt. Returns 202 Accepted. Poll GET /projects/{projectId}/tasks/{taskId} for progress events.

Requires the agent to have use_v3_agentic_flow enabled and the team to be on a plan that supports V3 agentic tasks (otherwise 402).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the agent

Body Params

Create a new V3 task and immediately submit the first prompt.

string | null

Task name. Defaults to the truncated prompt if omitted.

string
required

Prompt to send to OpenAI

string | null

Custom persona to use for the conversation

string | null
enum

Agent model to use for the conversation

string | null
enum
Defaults to default

By default, we ask ChatGPT to use only your content in its response (recommended). If you wish ChatGPT to improvise and use its own knowledgebase as well, you can set this to "openai_content".

Allowed:
string | null

Custom context to use for the conversation

file | null

File to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)

files[]
array of files | null

Multiple files to upload (Allowed types: pdf, docx, doc, odt, txt, jpg, jpeg, png, webp)

files[]
string | null
enum
Defaults to optimal-choice

Agent capability to use for the conversation.

Allowed:
labels[]
array | null

Optional source-label filter. Accepts two formats: (1) Flat array of label IDs or names for OR semantics, e.g. ["A","B","C"]. (2) Array of arrays for AND/OR logic (inner=OR, outer=AND), e.g. [["A","B"],["C","D"]] means (A OR B) AND (C OR D). Max 20 groups, 50 labels per group, 500 total. Invalid values are ignored.

labels[]
boolean
Defaults to false

If true, search only pages with provided labels. If false, search pages with provided labels plus unlabeled pages.

Responses

Updated 2 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago