Skip to content

AI API

4 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/agent-runs

Bearer token

Returns recent AGENT-01 durable job runs for the workspace (queued, running, succeeded, failed).

Path parameters

  • orgIdstring (uuid)required

Query parameters

  • pageinteger
  • limitinteger
  • statusstring

    one of queued, running, succeeded, failed, cancelled

  • jobTypestring

Responses

200Returns recent AGENT-01 durable job runs for the workspace (queued, running, succeeded, failed).
  • dataobjectrequired
    Fields
    • itemsarray<object>required
      Item fields
      • idstring (uuid)required
      • orgIdstring (uuid)required
      • jobTypestringrequired
      • statusstringrequired

        one of queued, running, succeeded, failed, cancelled

      • payloadobjectrequired
      • resultSummaryobject | nullrequired
      • attemptCountintegerrequired
      • maxAttemptsintegerrequired
      • idempotencyKeystring | nullrequired
      • errorMessagestring | nullrequired
      • costCreditsnumber | nullrequired
      • estimatedCostMilliUsdnumber | nullrequired
      • createdByUserIdstring (uuid) | nullrequired
      • startedAtstring | nullrequired
      • completedAtstring | nullrequired
      • createdAtstringrequired
      • updatedAtstringrequired
    • totalintegerrequired
    • pageintegerrequired
    • limitintegerrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/agent-runs" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/agent-runs/{runId}/steps

Bearer token

Returns the model rounds, tool calls and sub-agents recorded for one run, oldest first. This is how a background run reports progress — it has no event stream to subscribe to.

Path parameters

  • orgIdstring (uuid)required
  • runIdstring (uuid)required

Responses

200Returns the model rounds, tool calls and sub-agents recorded for one run, oldest first. This is how a background run reports progress — it has no event stream to subscribe to.
  • dataobjectrequired
    Fields
    • itemsarray<object>required
      Item fields
      • idstring (uuid)required
      • traceIdstringrequired
      • parentStepIdstring | nullrequired
      • rolestringrequired
      • kindstringrequired

        one of model_round, tool_call, subagent

      • statusstringrequired

        one of running, succeeded, failed

      • labelstring | nullrequired
      • inputobject | nullrequired
      • outputstring | nullrequired
      • reasoningSummarystring | nullrequired
      • promptTokensintegerrequired
      • completionTokensintegerrequired
      • reasoningTokensintegerrequired
      • durationMsinteger | nullrequired
      • errorMessagestring | nullrequired
      • createdAtstringrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/agent-runs/$RUN_ID/steps" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/ai/content/generate

Bearer token

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • promptstringrequired

Responses

200
  • dataobjectrequired
    Fields
    • resultstringrequired
    • creditsUsednumberrequired
    • remainingCreditsnumberrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/ai/content/generate" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{"prompt":"string"}'

POST/v1/orgs/{orgId}/ai/summarize

Bearer token

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • textstringrequired

Responses

200
  • dataobjectrequired
    Fields
    • resultstringrequired
    • creditsUsednumberrequired
    • remainingCreditsnumberrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/ai/summarize" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN" \
-H "Content-Type: application/json" \
-d '{"text":"string"}'