​
Run Object

​
id
string

ID of the task that a user can use for polling its status

​
result
object | null

The final result object, may vary based on task type.

​
status
string

any of completed, failed, in_progress

​
requirements_result
object[]

Detailed results for each requirement.

​
data_sources
object

Specifies the data sources used to retrieve contextual information for a run. Contains optional web_search and file_search results.

The example below shows a fully completed run object, including the requirements_result and data_sources fields.

These fields are not included by default and will only appear in the response if you explicitly request them using the include parameter.

For details on how to use this parameter, see the include parameter documentation.

​
Example:

{
  "id": "dba286ef-5067-4c6e-b215-5483500da8df",
  "status": "completed",
  "result": "- example 1\n- example 2\n- example 3",
  "requirements_result": {
    "score": 1,
    "finish_reason": "Perfect result achieved",
    "requirements": [
      {
        "name": "bullets",
        "description": "Return a bulleted list where each field is a bullet",
        "is_mandatory": false,
        "score": 1,
        "reason": "None"
      }
    ]
  },
  "data_sources": {
    "web_search": [
      {
        "id": "0686b7a3-6cb6-7128-8000-146778a91763",
        "text": "web search result text",
        "url": "https://example.com",
        "score": 0.01461567
      }
    ],
    "file_search": [
      {
        "text": "file search result text",
        "file_id": "aa50de3e-1624-4e9f-a6f4-488a1aa16759",
        "file_name": "example.pdf",
        "score": 0.7331293
      }
    ]
  }
}