Skip to main content
POST
/
external
/
agents
/
run
Run Agentic Task
curl --request POST \
  --url https://api.shieldbase.ai/external/agents/run \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Secret: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "agent_id": "<string>",
  "model": "<string>",
  "document_ids": [
    "<string>"
  ],
  "timeout_seconds": 600
}
'
{
  "conversation_id": "<string>",
  "output": "<string>",
  "generated_files": "<array>",
  "success": true
}

Authorizations

X-Client-ID
string
header
required
X-API-Key
string
header
required
X-Secret
string
header
required

Body

application/json
prompt
string
required
agent_id
string
model
string
document_ids
string[]
timeout_seconds
integer
default:600

Response

200 - application/json

Task completed

conversation_id
string
output
string
generated_files
array
success
boolean