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

# Postman Collection

> Pre-built API request templates to get started quickly

To help you get started quickly, we provide a Postman Collection with pre-configured API requests for all Opus Job Operator endpoints.

## Download Collection

<Card title="Download Postman Collection" icon="download" href="https://drive.google.com/open?id=1BMG05fHj33rH3vgw2N9Ma1yoYDogL8va">
  Get the complete collection with all API endpoints
</Card>

## Setup Instructions

<Steps>
  <Step title="Import the Collection">
    Open Postman and import the downloaded collection file.
  </Step>

  <Step title="Configure Base URL">
    Create a Postman environment or collection variable named `base_url` and set it to:

    ```
    https://operator.opus.com
    ```
  </Step>

  <Step title="Add Authentication">
    Include your API key in the Headers tab of each request:

    ```
    x-service-key: <your_service_key>
    ```

    Alternatively, configure it as a collection-level variable for reuse across all requests.
  </Step>

  <Step title="Replace Placeholders">
    Update the following template values with your actual identifiers:

    * `put_your_workflow_id_here` → Your actual workflow ID
    * `put_your_job_id_here` → Your actual job execution ID
  </Step>
</Steps>

## Included Requests

The collection contains pre-configured requests for:

| Endpoint             | Method | Description                                     |
| -------------------- | ------ | ----------------------------------------------- |
| Get Workflow Details | GET    | Retrieve workflow schema and input requirements |
| Initiate Job         | POST   | Create a new job instance                       |
| Upload File          | POST   | Generate presigned file upload URL              |
| Execute Job          | POST   | Run workflow with inputs                        |
| Get Job Status       | GET    | Check execution progress                        |
| Get Job Results      | GET    | Retrieve completed job outputs                  |
| Job Audit Log        | GET    | Access execution history                        |