Sign in
agent

Changed on
post/v1/api/ai/runs

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/api/ai/runs
  • Auth: none declared

Request body

approvalboolean

Whether this agent run requires approval before continuing

branchstring

The branch this agent run should operate on (if not set, the repository default branch is used)

flow_idstring

Optional flow ID to associate this agent run with

mode'analyze' | 'write' | 'review' required

Mode of the agent run (analyze for read-only, write for modifications)

promptstring required

The prompt to give to the agent describing the task to perform

repositorystring required

The git repository URL the agent will work on (https or ssh format)

runtime_idstring required

The runtime ID to execute the agent run on

sharedboolean

Whether to share this agent run publicly

Response

no description

approvalboolean

Whether this agent run requires approval before continuing

approved_atstring date-time

When this agent run was approved

branchstring

The git branch the agent is operating on (uses default branch if not set)

errorstring

Error message if the agent run failed

flow_idstring

ID of the flow this agent run is associated with, if any

followupboolean

Whether this agent run is a follow-up to a pull request

followup_pr_urlstring

The pull request URL this follow-up run is targeting

idstring

Unique identifier for the agent run

inserted_atstring date-time
language'javascript' | 'python' | 'java' | 'cpp' | 'csharp' | 'go' | 'ruby' | 'php' | 'terraform'

Programming language used in the agent run (javascript, python, java, cpp, csharp, go, ruby, php, terraform)

language_versionstring

Specific version of the programming language to use

mode'analyze' | 'write' | 'review'

Mode of the agent run (analyze for read-only analysis, write for code modifications)

promptstring

The prompt given to the AI agent to process

repositorystring

The git repository URL the agent is working on

runtime_idstring

ID of the runtime executing this agent run

sharedboolean

Whether this agent run is shared publicly

status'pending' | 'running' | 'successful' | 'failed' | 'cancelled' | 'babysitting' | 'pending_approval'

Current status of the agent run (pending, running, successful, failed, cancelled)

updated_atstring date-time
user_idstring

ID of the user who initiated this agent run

Changes

  • b70919d87a08Revision changes
    • warning

      added the new review enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new review enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • d9bc4984fd8cRevision changes
    • warning

      added the new pending_approval enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status