SWswarms
Logging
Results
Completions
Jobs
Job Retrieval
History
Data Access

Get a Completion by Job ID

Changed on

Fetch the stored result of a past completion by the job_id its response returned, or of a past /v1/agent/batch/completions call by its batch_id. Returns 404 when no completion with that id belongs to any API key on the caller's account, and 503 when the lookup fails and can be retried.

get/v1/job/{job_id}

Request

  • Base URL
    https://api.swarms.world
  • URL
    https://api.swarms.world/v1/job/{job_id}
  • Auth
    none declared. Required headers: x-api-key

Path parameters

job_idstring required

Headers

x-api-keystring required

Response

Successful Response

job_idstring nullable

The job_id the completion response returned. Absent on /v1/agent/batch/completions results, which carry batch_id instead.

batch_idstring nullable

The batch_id a /v1/agent/batch/completions response returned. Present only on batch results.

statusstring nullable

The run's status, e.g. 'success'. Absent on /v1/agent/completions results, which report success instead.

usageobject nullable

Token counts and the cost charged for the run, as the original response reported them.

timestampstring nullable

When the run finished, in ISO 8601. Absent on /v1/swarm/completions results.

Changes

  • 3d783c6da122Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property job_id list-of-types was widened by adding types null to media type application/json of response 200

    • info

      added the optional property to the response with the status

  • 500c79520e41Revision changes
    • info

      endpoint added