Neo

Returns every organization member joined with their per-member monthly Neo usage cap, their month-to-date Neo spend, and their effective limit (the smaller of the per-member and org-level caps). Caps are denominated in cents.

Request Parameters

• orgName string path required
  The organization name

Responses

Creates or replaces the monthly Neo usage cap for a single member of an organization. The cap must be at least $10/month. To remove the cap, call DeleteNeoMemberUsageCap.

Request Parameters

• orgName string path required
  The organization name
• userID string path required
  The member’s user ID

Request Body

Responses

Removes the monthly Neo usage cap for a single member, returning them to only the org-level cap (if any). Idempotent — deleting when no cap is set returns 204.

Request Parameters

• orgName string path required
  The organization name
• userID string path required
  The member’s user ID

Responses

Returns the current Neo-token allowance and consumption for the binding (closest-to-exhaustion) in-force Neo limit for a context. Returns 404 when no Neo-token cap applies to this organization.

Request Parameters

• orgName string path required
  The organization name
• taskId string query optional
  When supplied, returns the budget for this task’s owner instead of the caller. Must resolve to a task within orgName.

Responses

Returns the org admin-configured monthly Neo usage cap for an organization, or 204 (no content) when no cap is configured (the default). Caps are denominated in cents.

Request Parameters

• orgName string path required
  The organization name

Responses

Creates or replaces the monthly Neo usage cap for an organization. The cap must be at least $10/month. To remove the cap, call DeleteNeoUsageCap.

Request Parameters

• orgName string path required
  The organization name

Request Body

Responses

Removes the monthly Neo usage cap for an organization, returning it to the uncapped default. Idempotent — deleting when no cap is set returns 204.

Request Parameters

• orgName string path required
  The organization name

Responses

Lists the Custom Agent definitions configured for the organization, ordered by name. Each definition is a saved, team-owned agent configuration (role, integrations, and instructions) that a task can be run as.

Request Parameters

• orgName string path required
  The organization name

Responses

Creates a Custom Agent definition for the organization from the supplied configuration (name, optional RBAC role, integrations, and instructions). Requires agent_definitions:create, granted to organization admins by default. Returns the created definition including its generated id. Returns 404 if a supplied role does not exist in the organization.

Request Parameters

• orgName string path required
  The organization name

Request Body

Responses

Retrieves a single Custom Agent definition by id. Returns 404 if the definition does not exist in the organization.

Request Parameters

• orgName string path required
  The organization name
• definitionID string path required
  The agent definition identifier

Responses

Replaces the configuration of an existing Custom Agent definition (name, role, integrations, and instructions). Requires agent_definitions:update, granted to organization admins by default. Returns the updated definition. Returns 404 if the definition or a supplied role does not exist in the organization.

Request Parameters

• orgName string path required
  The organization name
• definitionID string path required
  The agent definition identifier

Request Body

Responses

Deletes a Custom Agent definition. Runs the agent has already produced are kept and still name it, so the audit trail survives the agent. Requires agent_definitions:delete, granted to organization admins by default. Returns 404 if the definition does not exist in the organization.

Request Parameters

• orgName string path required
  The organization name
• definitionID string path required
  The agent definition identifier

Responses

Pauses or resumes a Custom Agent. When paused, the agent remains configured but starts no new runs from any source – console, schedule, or trigger – until it is resumed; runs already in flight continue. Pausing is recorded against the calling user; resuming clears that attribution along with the reason. Returns 404 if the definition does not exist in the organization.

Request Parameters

• orgName string path required
  The organization name
• definitionID string path required
  The agent definition identifier

Request Body

Responses

Lists the tasks that were run as a given Custom Agent, across every member of the organization — the agent’s shared run history, not just the caller’s own runs. Supports pagination via continuationToken with a configurable pageSize (1-1000, default 100). Returns 404 if the definition does not exist in the organization.

Request Parameters

• orgName string path required
  The organization name
• definitionID string path required
  The agent definition identifier
• continuationToken string query optional
  Token for retrieving the next page of results
• pageSize integer query optional
  Number of results per page
• sortBy string query optional
  Field to sort the results by. Defaults to lastEvent.
• sortDirection string query optional
  Direction to sort the results in. Defaults to desc.

Responses

Lists all agent tasks for the specified organization. Supports pagination via continuationToken with a configurable pageSize (1-1000, default 100). Returns task metadata including ID, name, status, and creation timestamp.

Request Parameters

• orgName string path required
  The organization name
• agentDefinitionId string query optional
  Agent definition ID to filter by. Use ’neo’ for tasks without a custom agent. Omit to include all agents.
• continuationToken string query optional
  Token for retrieving the next page of results
• excludeSources array query optional
  Task origins to exclude from the results.
• pageSize integer query optional
  Number of results per page
• policyIssueId string query optional
  Policy issue ID to filter by. Returns only tasks linked to that issue, such as tasks launched to remediate it.
• query string query optional
  Case-insensitive text to match in the task name.
• sortBy string query optional
  Field to sort the results by. Defaults to lastEvent.
• sortDirection string query optional
  Direction to sort the results in. Defaults to desc.
• status string query optional
  Execution status to filter by.
• taskType string query optional
  Task type to filter by. Omit to include both interactive and background tasks.

Responses

Creates a new agent task for the specified organization. The request must include a prompt (the user event message) that initiates the task. The message is a user message, so its discriminator field must be set to “type”: “user_message”. Set the ‘permissionMode’ field in the request body to restrict the agent to read-only operations. Returns the created task details including task ID, name, status, and timestamp.

Request Parameters

• orgName string path required
  The organization name

Request Body

Responses

Retrieves metadata for a specific agent task, including its ID, name, status, creation timestamp, and associated entities. Returns 404 if the task does not exist.

Request Parameters

• orgName string path required
  The organization name
• taskID string path required
  The agent task identifier

Responses

Sends a response to an ongoing agent task. Supported event types include user_message, user_confirmation, and user_cancel. Returns 409 if the task already has a pending request that has not completed.

Request Parameters

• orgName string path required
  The organization name
• taskID string path required
  The agent task identifier

Request Body

Responses

Updates the settings or metadata of an agent task. Only the user who created the task can modify it. A change to the task’s assumed role takes effect starting with the next turn of the conversation.

Request Parameters

• orgName string path required
  The organization name
• taskID string path required
  The agent task identifier

Request Body

Responses

Cancels an agent task. When force is true, immediately terminates the runtime session and resets the task to idle. This is the escalation path when a graceful cancel (via the user_cancel event in RespondToTask) is insufficient or the task is stuck. Unlike graceful cancel, force-cancel does not attempt to notify the agent runtime — it kills the session directly and resets the task state. Currently only force cancellation is supported; the force field must be set to true. Returns 409 if the session was stopped but the task status could not be reset to idle.

Request Parameters

• orgName string path required
  The organization name
• taskID string path required
  The agent task identifier

Request Body

Responses

Retrieves the event stream for a specific agent task. Events include agent messages, tool calls, status changes, and user interactions. Supports pagination via continuationToken with a configurable pageSize (1-1000).

Request Parameters

• orgName string path required
  The organization name
• taskID string path required
  The agent task identifier
• continuationToken string query optional
  Token for retrieving the next page of results
• pageSize integer query optional
  Number of results per page

Responses

Streams events for a specific agent task as Server-Sent Events. Each SSE data frame contains a JSON-encoded AgentConsoleEvent. The stream delivers existing events immediately, then keeps the connection open to deliver new events in real time until the task completes.

Request Parameters

• orgName string path required
  The organization name
• taskID string path required
  The agent task identifier

Responses