Skip to main content
POST
/
v1
/
organizations
/
{org_id}
/
agent
/
run
Create Agent Run
curl --request POST \
  --url https://api.codegen.com/v1/organizations/{org_id}/agent/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "images": [
    "<string>"
  ],
  "metadata": {}
}
'
{
  "id": 123,
  "organization_id": 123,
  "status": "<string>",
  "created_at": "<string>",
  "web_url": "<string>",
  "result": "<string>",
  "source_type": "LOCAL",
  "github_pull_requests": [
    {
      "id": 123,
      "title": "<string>",
      "url": "<string>",
      "created_at": "<string>"
    }
  ],
  "metadata": {}
}

Headers

​
authorization
any

Path Parameters

​
org_id
integer
required

Body

application/json
​
prompt
string
required
​
images
string[] | null

List of base64 encoded data URIs representing images to be processed by the agent

​
metadata
object | null

Arbitrary JSON metadata to be stored with the agent run

Response

Successful Response

Represents an agent run in API responses

​
id
integer
required
​
organization_id
integer
required
​
status
string | null
​
created_at
string | null
​
web_url
string | null
​
result
string | null
​
source_type
enum<string> | null
Available options:
LOCAL,
SLACK,
GITHUB,
GITHUB_CHECK_SUITE,
LINEAR,
API,
CHAT,
JIRA
​
github_pull_requests
GithubPullRequestResponse · object[] | null
​
metadata
object | null