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

# Start one workflow run

> Starts the enabled published API-triggered workflow for this agent. The request body is a flat object of at most 50 configured scalar fields; unknown fields, objects and arrays are rejected. The published schema controls validation. The organization x-api-key is sufficient; HMAC signing is not required on this route. A successful response contains a durable run ID that can be read immediately, even while queued. Reuse an optional Idempotency-Key with an unchanged body to recover the same run; omit it for a distinct run each time.



## OpenAPI

````yaml /openapi.json post /workflows/{agentId}/run
openapi: 3.1.0
info:
  title: 11x API
  version: 1.0.0
  description: >-
    API for 11x AI agents. Programmatically enroll contacts into agent calling
    sequences, manage sequences, and track credit usage. All requests are
    authenticated with an organization API key in the `x-api-key` header. The
    bulk scheduling endpoint also enforces a configurable per-agent rate limit
    and returns HTTP 429 when exceeded.
servers:
  - url: https://julian.11x.ai/api/v1
security:
  - apiKeyAuth: []
tags:
  - name: Workflows
    description: Start an API-triggered workflow and inspect its runs.
  - name: Scheduling
    description: Enroll contacts into an agent's calling sequence.
  - name: Sequences
    description: Manage active sequences.
  - name: Agents
    description: Read agent configuration.
  - name: Conversation Meetings
    description: >-
      Manage the meeting booked during a conversation — list its attendees, add
      attendees before it starts, and cancel it. Every endpoint is addressed by
      an `entityId` that identifies the conversation. Today only voice calls are
      supported, with the form of the call prefix followed by the call ID (e.g.
      `call.abc123`). The meeting is resolved from the calendar booking created
      during the conversation, and the calendar provider remains the source of
      truth.
  - name: Conversation Metadata
    description: >-
      Retrieve completed conversation data asynchronously — designed for batch
      ingestion, backfills, and reconciliation jobs that pull conversation
      metadata instead of receiving it through a webhook.


      **Recommended batch ingestion flow:**


      1. Call `GET /conversations/search/{agentId}` with the time window you
      want to ingest (e.g. yesterday or the last seven days).

      2. Iterate through the returned `sequenceIds`.

      3. For each sequence ID, call `GET /conversations/metadata/{sequenceId}`.

      4. Store the returned `metadata` array in your warehouse.

      5. Use `limit`, `offset`, and `hasMore` to paginate through larger
      backfills.
  - name: Credits
    description: Track credit utilization.
  - name: Webhooks
    description: Events 11x sends to your endpoint.
  - name: Recordings
    description: >-
      Fetch call audio, and optionally transcripts.


      A recording belongs to a single call, so `GET /recordings/{callId}` is
      addressed by call ID. The bulk endpoint selects by **sequence** ID
      instead, because that is the unit `GET /conversations/search/{agentId}`
      returns — same resource, two selectors.


      **Bulk export flow:**


      1. Call `GET /conversations/search/{agentId}` for the window you want.

      2. Pass a page of the returned `sequenceIds` to `POST /recordings` (up to
      100 per request).

      3. Download each `url` before it expires; re-fetch individual calls later
      with `GET /recordings/{callId}`.


      Recording URLs are signed and short-lived — see `expiresAt` on each entry.
paths:
  /workflows/{agentId}/run:
    post:
      tags:
        - Workflows
      summary: Start one workflow run
      description: >-
        Starts the enabled published API-triggered workflow for this agent. The
        request body is a flat object of at most 50 configured scalar fields;
        unknown fields, objects and arrays are rejected. The published schema
        controls validation. The organization x-api-key is sufficient; HMAC
        signing is not required on this route. A successful response contains a
        durable run ID that can be read immediately, even while queued. Reuse an
        optional Idempotency-Key with an unchanged body to recover the same run;
        omit it for a distinct run each time.
      operationId: startWorkflowRun
      parameters:
        - $ref: '#/components/parameters/AgentId'
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 255
          description: >-
            Unique per organization and agent while the run remains queryable.
            Reusing it with a different body returns 422.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              maxProperties: 50
              additionalProperties:
                oneOf:
                  - type: string
                  - type: number
                  - type: boolean
              description: >-
                Fields and required keys depend on the published Start API
                request schema. Field names use lower camelCase or snake_case,
                begin with a lowercase letter, contain at most 64 characters,
                and are unique regardless of case.
            example:
              contact_name: Example Person
              priority: 2
      responses:
        '201':
          description: Run admitted and queued.
          content:
            application/json:
              schema:
                type: object
                required:
                  - workflowRunId
                properties:
                  workflowRunId:
                    type: string
              example:
                workflowRunId: wf-run.example
        '400':
          description: Invalid JSON, configured field, or idempotency header.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Agent not found or no enabled published API workflow.
        '409':
          description: The published API input schema is invalid.
        '422':
          description: Idempotency-Key already used with a different request body.
        '429':
          description: >-
            The agent's per-minute workflow-run rate limit was exceeded; retry
            after the Retry-After interval.
        '500':
          description: Unable to admit the run.
components:
  parameters:
    AgentId:
      name: agentId
      in: path
      required: true
      description: ID of the agent, e.g. `agent.abc123`.
      schema:
        type: string
  responses:
    Unauthorized:
      description: >-
        `UNAUTHORIZED` or `INVALID_API_KEY` — API key missing, invalid, or not
        authorized for this agent's organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error: UNAUTHORIZED
                message: >-
                  API key is required. Please provide your API key in the
                  x-api-key header.
            invalidApiKey:
              summary: Invalid API key
              value:
                error: INVALID_API_KEY
                message: The provided API key is invalid.
  schemas:
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Machine-readable error code.
          example: INVALID_PHONE_NUMBER
        message:
          type: string
          description: Human-readable explanation.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Organization API key. Get it from the 11x team or from the platform.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.