> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creao.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get agent edit status

> Fetch status and result metadata for an agent edit.



## OpenAPI

````yaml /api-reference/developer-v1.openapi.yaml get /v1/agents/{agent_id}/edits/{run_id}
openapi: 3.1.0
info:
  title: CREAO Developer API
  version: 1.0.0
  description: |
    Create, update, and run personal CREAO agents from your backend with
    Account API keys. The v1 API uses stable `agent_id`, `conversation_id`, and
    `run_id` identifiers and is served from `developer.creao.ai`.
servers:
  - url: https://developer.creao.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: Create, update, and edit personal agents for the authenticated account.
  - name: Runs
    description: Create, stream, fetch, and list Developer API runs.
paths:
  /v1/agents/{agent_id}/edits/{run_id}:
    get:
      tags:
        - Agents
      summary: Get agent edit status
      description: Fetch one natural-language agent edit by its backing `run_id`.
      operationId: getAgentEdit
      parameters:
        - name: agent_id
          in: path
          required: true
          description: Personal CREAO agent being edited.
          schema:
            type: string
            format: uuid
        - name: run_id
          in: path
          required: true
          description: Run ID returned by `POST /v1/agents/{agent_id}/edits`.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Agent edit status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentEdit'
              examples:
                succeeded:
                  value:
                    run_id: 11111111-1111-4111-8111-111111111111
                    agent_id: 00000000-0000-4000-8000-000000000000
                    status: succeeded
                    result:
                      text: >-
                        Updated the agent instructions and added a valuation
                        sensitivity section.
                    usage:
                      credits: 2.5
                    created_at: '2026-07-03T10:00:00.000Z'
                    started_at: '2026-07-03T10:00:02.000Z'
                    completed_at: '2026-07-03T10:00:45.000Z'
        '400':
          $ref: '#/components/responses/InvalidInput'
        '401':
          $ref: '#/components/responses/AuthenticationRequired'
        '404':
          description: Run not found for this account or agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                runNotFound:
                  value:
                    error: RUN_NOT_FOUND
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    AgentEdit:
      type: object
      required:
        - run_id
        - agent_id
        - status
      properties:
        run_id:
          type: string
          format: uuid
          description: Backing Developer API run ID for polling/debugging.
        agent_id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/AgentEditStatus'
        result:
          type: object
          additionalProperties: true
          description: Terminal edit result when the edit succeeds.
        usage:
          $ref: '#/components/schemas/Usage'
        error:
          $ref: '#/components/schemas/RunError'
        created_at:
          type: string
          format: date-time
        started_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
        completed_at:
          oneOf:
            - type: string
              format: date-time
            - type: 'null'
    ErrorResponse:
      type: object
      additionalProperties: true
      required:
        - error
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
          description: Debug message. Do not rely on this field in production clients.
        available:
          type: number
          description: Available credits, when returned for credit errors.
        required:
          type: number
          description: Required credits, when returned for credit errors.
        retryAfterSeconds:
          type: integer
          description: Retry delay, when returned for hourly cap errors.
    AgentEditStatus:
      type: string
      enum:
        - queued
        - running
        - succeeded
        - failed
        - cancelled
    Usage:
      type: object
      required:
        - credits
      properties:
        credits:
          type: number
          description: Credits attributed to this Developer API run.
    RunError:
      type: object
      required:
        - code
      properties:
        code:
          type: string
          description: Stable machine-readable failure code.
  responses:
    InvalidInput:
      description: Invalid request shape, invalid UUID, or unsupported status filter.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidInput:
              value:
                error: INVALID_INPUT
    AuthenticationRequired:
      description: Missing, malformed, revoked, or unknown Account API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingKey:
              value:
                error: AUTHENTICATION_REQUIRED
    RateLimited:
      description: Account-level or IP-level rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                error: RATE_LIMITED
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cr_sk
      description: Account API key from Developer Console. Keys start with `cr_sk_`.
      x-default: cr_sk_your_key_here

````