Skip to main content
POST
/
api
/
v1
/
agent-executions
Create Agent Execution
curl --request POST \
  --url https://api.example.com/api/v1/agent-executions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'input_files=<string>' \
  --form input_files.items='@example-file'
{
  "agentId": "<string>",
  "workspaceId": "<string>",
  "state": {
    "status": "PENDING_INPUTS"
  },
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.askui.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
agent_id
string<uuid4>
required

Body

multipart/form-data
​
input_files
file[]
required

Files to extract data from. Supported file extensions: {'.eml', '.webp', '.jpg', '.gif', '.jpeg', '.txt', '.pdf', '.png'}. Maximum total size: 100 MiB. We process the .eml files as text files, i.e., we don't process non-textual attachments and content properly. For that, extract them from the .eml files separating them into different files.

Minimum array length: 1

Response

Successful Response

​
agentId
string<uuid4>
required
​
workspaceId
string<uuid4>
required
​
state
AgentExecutionStatePendingInputs · object
required
​
id
string<uuid4>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>