Cadence Orders API

openapi: 3.2.0
info:
  title: Cadence Translate Orders API
  description: API for translating text using the Cadence Translate service.
  version: 1.0.0
tags:
- name: Orders
paths:
  /orders:
    post:
      tags:
      - Orders
      summary: Create Order
      operationId: create_order_orders_post
      parameters:
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_OrderIdResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Orders
      summary: List Orders
      operationId: list_orders_orders_get
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/ExternalOrderStatus'
          maxItems: 100
          description: Filter by order status. Supports multiple values.
          default: []
          title: Status
        description: Filter by order status. Supports multiple values.
      - name: clientProjectId
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: Search by order-level client project ID (ILIKE).
          title: Clientprojectid
        description: Search by order-level client project ID (ILIKE).
      - name: clientExternalId
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: Search by service-level client external ID (ILIKE).
          title: Clientexternalid
        description: Search by service-level client external ID (ILIKE).
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 50
          title: Limit
      - name: after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: After
      - name: before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Before
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_NeoCursorPaginatedResult_OrderDetailRead__'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /orders/{order_id}:
    get:
      tags:
      - Orders
      summary: Get Order
      operationId: get_order_orders__order_id__get
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Order Id
      - name: x-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response_OrderDetailWithItemsRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TranscriptServiceEntry:
      properties:
        contentUrl:
          anyOf:
          - type: string
            maxLength: 2083
            minLength: 1
            format: uri
          - type: 'null'
          title: Contenturl
        sourceLanguage:
          anyOf:
          - $ref: '#/components/schemas/InternalLanguageCodeEnum'
          - type: 'null'
          default: undefined
        serviceType:
          $ref: '#/components/schemas/ServiceType'
        isRush:
          type: boolean
          title: Isrush
          default: false
        turnaroundTime:
          $ref: '#/components/schemas/TurnAroundTime'
          default: 48 hours
        clientExternalId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientexternalid
        overrides:
          $ref: '#/components/schemas/ServiceOverrides'
        topic:
          anyOf:
          - type: string
          - type: 'null'
          title: Topic
        dateOfInterview:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Dateofinterview
          description: Date the interview was conducted; rendered by FORMATTING.
        industry:
          anyOf:
          - type: string
          - type: 'null'
          title: Industry
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        glossaryTerms:
          items:
            type: string
          type: array
          title: Glossaryterms
        speakers:
          items:
            $ref: '#/components/schemas/Speaker'
          type: array
          title: Speakers
        serviceGroup:
          type: string
          const: transcript
          title: Servicegroup
        targetLanguage:
          anyOf:
          - $ref: '#/components/schemas/InternalLanguageCodeEnum'
          - type: 'null'
          default: undefined
        meetingRecording:
          anyOf:
          - $ref: '#/components/schemas/MeetingRecordingRequest'
          - type: 'null'
      additionalProperties: false
      type: object
      required:
      - serviceType
      - serviceGroup
      title: TranscriptServiceEntry
    OrderItemDetailRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        orderId:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Orderid
        clientExternalId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientexternalid
        serviceType:
          $ref: '#/components/schemas/ServiceType'
        serviceGroup:
          $ref: '#/components/schemas/ServiceGroup'
        contentUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Contenturl
        deliverySettings:
          $ref: '#/components/schemas/DeliverySettingsRead'
        sourceLanguage:
          $ref: '#/components/schemas/InternalLanguageCodeEnum'
        targetLanguage:
          $ref: '#/components/schemas/InternalLanguageCodeEnum'
        turnaroundTime:
          anyOf:
          - $ref: '#/components/schemas/TurnAroundTime'
          - type: 'null'
        status:
          $ref: '#/components/schemas/ExternalOrderStatus'
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
      - id
      - serviceType
      - serviceGroup
      - deliverySettings
      - sourceLanguage
      - targetLanguage
      - status
      - createdAt
      - updatedAt
      title: OrderItemDetailRead
      description: Client-facing order item read shape for GET /orders/{order_id}.
    TemplateFormat:
      type: string
      enum:
      - docx
      - json
      - txt
      - srt
      title: TemplateFormat
      description: Transcript template format.
    InternalLanguageCodeEnum:
      type: string
      enum:
      - ar
      - zh-cn
      - zh-hk
      - zh-tw
      - nl
      - en
      - fr
      - de
      - he
      - hi
      - id
      - it
      - ja
      - ko
      - 'no'
      - pt
      - pt-br
      - ru
      - es
      - sv
      - tr
      - vi
      - da
      - undefined
      title: InternalLanguageCodeEnum
      description: Enum for internal language codes.
    ServiceGroup:
      type: string
      enum:
      - transcript
      - translation
      - interpretation
      - market_research
      title: ServiceGroup
      description: Broad family a service belongs to.
    MeetingRecordingRequest:
      properties:
        meetingUrl:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Meetingurl
        scheduledStartAt:
          type: string
          format: date-time
          title: Scheduledstartat
        estimatedDurationMin:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Estimateddurationmin
      additionalProperties: false
      type: object
      required:
      - meetingUrl
      - scheduledStartAt
      title: MeetingRecordingRequest
      description: 'What an order entry supplies to have its meeting recorded.


        Nested inside ``TranscriptServiceEntry`` at order intake, so it forbids

        unknown keys like the entries around it.'
    OrderAttachmentCreate:
      properties:
        shareWithFreelancer:
          type: boolean
          title: Sharewithfreelancer
          default: false
        shareWithClient:
          type: boolean
          title: Sharewithclient
          default: false
        s3Key:
          type: string
          title: S3Key
        fileName:
          type: string
          maxLength: 255
          minLength: 1
          title: Filename
        contentType:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Contenttype
        sizeBytes:
          anyOf:
          - type: integer
            minimum: 0.0
          - type: 'null'
          title: Sizebytes
      additionalProperties: false
      type: object
      required:
      - s3Key
      - fileName
      title: OrderAttachmentCreate
      description: 'One uploaded file to record against an order.


        ``s3_key`` must be a key minted by ``POST /core/upload-url`` for this

        environment; anything else is a 422 on ``s3Key``.'
    DeliverySettings:
      items:
        oneOf:
        - $ref: '#/components/schemas/EmailDelivery'
        - $ref: '#/components/schemas/WebhookDelivery'
        discriminator:
          propertyName: method
          mapping:
            EMAIL: '#/components/schemas/EmailDelivery'
            WEBHOOK: '#/components/schemas/WebhookDelivery'
      type: array
      maxItems: 5
      title: DeliverySettings
    Response_NeoCursorPaginatedResult_OrderDetailRead__:
      properties:
        message:
          type: string
          title: Message
          default: Operation successful
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
          - $ref: '#/components/schemas/NeoCursorPaginatedResult_OrderDetailRead_'
          - type: 'null'
        errors:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Errors
      type: object
      title: Response[NeoCursorPaginatedResult[OrderDetailRead]]
    ServiceOverrides:
      properties:
        deliverySettings:
          $ref: '#/components/schemas/DeliverySettings'
      additionalProperties: false
      type: object
      title: ServiceOverrides
    InterpretationServiceEntry:
      properties:
        contentUrl:
          anyOf:
          - type: string
            maxLength: 2083
            minLength: 1
            format: uri
          - type: 'null'
          title: Contenturl
        sourceLanguage:
          anyOf:
          - $ref: '#/components/schemas/InternalLanguageCodeEnum'
          - type: 'null'
          default: undefined
        serviceType:
          $ref: '#/components/schemas/ServiceType'
        isRush:
          type: boolean
          title: Isrush
          default: false
        turnaroundTime:
          $ref: '#/components/schemas/TurnAroundTime'
          default: 48 hours
        clientExternalId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientexternalid
        overrides:
          $ref: '#/components/schemas/ServiceOverrides'
        serviceGroup:
          type: string
          const: interpretation
          title: Servicegroup
        targetLanguage:
          $ref: '#/components/schemas/InternalLanguageCodeEnum'
        scheduledStartAt:
          type: string
          format: date-time
          title: Scheduledstartat
        estimatedDurationMin:
          type: integer
          exclusiveMinimum: 0.0
          title: Estimateddurationmin
        channelDetails:
          $ref: '#/components/schemas/InterpretationVideoDetails'
        driveLinks:
          items:
            $ref: '#/components/schemas/DriveLinkCreate'
          type: array
          maxItems: 20
          title: Drivelinks
        referenceMaterials:
          items:
            $ref: '#/components/schemas/OrderAttachmentCreate'
          type: array
          maxItems: 20
          title: Referencematerials
        recordMeeting:
          type: boolean
          title: Recordmeeting
          default: false
      additionalProperties: false
      type: object
      required:
      - serviceType
      - serviceGroup
      - targetLanguage
      - scheduledStartAt
      - estimatedDurationMin
      - channelDetails
      title: InterpretationServiceEntry
    NeoCursorPaginatedResult_OrderDetailRead_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/OrderDetailRead'
          type: array
          title: Items
          description: List of items in this page
        hasNext:
          type: boolean
          title: Hasnext
          description: Whether there are more items after this page
        hasPrevious:
          type: boolean
          title: Hasprevious
          description: Whether there are items before this page
        nextCursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Nextcursor
          description: Cursor to fetch the next page. Pass as after parameter.
        previousCursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Previouscursor
          description: Cursor to fetch the previous page. Pass as before parameter.
        totalItemsCount:
          anyOf:
          - type: integer
          - type: 'null'
          title: Totalitemscount
          description: Total number of items matching the current filters (without pagination)
      type: object
      required:
      - items
      - hasNext
      - hasPrevious
      - nextCursor
      - previousCursor
      title: NeoCursorPaginatedResult[OrderDetailRead]
    OrderDefaultsCreate:
      properties:
        deliverySettings:
          $ref: '#/components/schemas/DeliverySettings'
      additionalProperties: false
      type: object
      title: OrderDefaultsCreate
      description: Write shape for order-level defaults.
    SpeakerType:
      type: string
      enum:
      - interviewer
      - interviewee
      - host
      - interpreter
      title: SpeakerType
      description: Role a speaker plays in the conversation.
    ServiceType:
      type: string
      enum:
      - AI
      - HITL
      - AI_TRANSLATED
      - HITL_TRANSLATED
      - AI_LITE
      - HITL_LITE
      - SF_LLM_QA
      - AI_V1
      - AI_V1_TRANSLATED
      - TRANSLATION
      - MARKET_RESEARCH
      - RCI
      - RSI
      - OPI
      - OSI
      title: ServiceType
      description: Type of service offered to a client.
    DeliverySettingRead:
      properties:
        method:
          anyOf:
          - type: string
          - type: 'null'
          title: Method
        templateFormat:
          anyOf:
          - type: string
          - type: 'null'
          title: Templateformat
        templateId:
          anyOf:
          - type: string
            format: uuid
          - type: string
          - type: 'null'
          title: Templateid
        emails:
          items:
            type: string
          type: array
          title: Emails
        callbackUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Callbackurl
      type: object
      title: DeliverySettingRead
      description: Client read shape that omits persisted webhook header values.
    OrderDetailWithItemsRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        organizationId:
          type: string
          format: uuid
          title: Organizationid
        clientProjectId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientprojectid
        clientProjectName:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientprojectname
        status:
          $ref: '#/components/schemas/ExternalOrderStatus'
        itemsCount:
          type: integer
          title: Itemscount
          default: 0
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
        items:
          items:
            $ref: '#/components/schemas/OrderItemDetailRead'
          type: array
          title: Items
      type: object
      required:
      - id
      - organizationId
      - status
      - createdAt
      - updatedAt
      - items
      title: OrderDetailWithItemsRead
      description: Order detail projection returned by GET /orders/{order_id}.
    DriveLinkCreate:
      properties:
        shareWithFreelancer:
          type: boolean
          title: Sharewithfreelancer
          default: false
        shareWithClient:
          type: boolean
          title: Sharewithclient
          default: false
        url:
          type: string
          maxLength: 2048
          title: Url
        label:
          type: string
          maxLength: 255
          title: Label
          default: ''
      additionalProperties: false
      type: object
      required:
      - url
      title: DriveLinkCreate
    DeliverySettingsRead:
      items:
        $ref: '#/components/schemas/DeliverySettingRead'
      type: array
      title: DeliverySettingsRead
      description: Client read wrapper without write-time delivery validators.
    Speaker:
      properties:
        firstName:
          type: string
          title: Firstname
        lastName:
          type: string
          title: Lastname
        speakerType:
          anyOf:
          - $ref: '#/components/schemas/SpeakerType'
          - type: 'null'
          description: Role the speaker plays in the conversation.
        audioChannelId:
          anyOf:
          - type: string
          - type: 'null'
          title: Audiochannelid
        originalLabel:
          anyOf:
          - type: string
          - type: 'null'
          title: Originallabel
          description: Label the speaker had in the raw transcript (e.g. S1 or Speaker 1); kept on the order for reference. Speaker labels are managed in Mega Editor.
      additionalProperties: false
      type: object
      required:
      - firstName
      - lastName
      title: Speaker
      description: Schema for a speaker in a transcript.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TranslationServiceEntry:
      properties:
        contentUrl:
          anyOf:
          - type: string
            maxLength: 2083
            minLength: 1
            format: uri
          - type: 'null'
          title: Contenturl
        sourceLanguage:
          anyOf:
          - $ref: '#/components/schemas/InternalLanguageCodeEnum'
          - type: 'null'
          default: undefined
        serviceType:
          $ref: '#/components/schemas/ServiceType'
        isRush:
          type: boolean
          title: Isrush
          default: false
        turnaroundTime:
          $ref: '#/components/schemas/TurnAroundTime'
          default: 48 hours
        clientExternalId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientexternalid
        overrides:
          $ref: '#/components/schemas/ServiceOverrides'
        serviceGroup:
          type: string
          const: translation
          title: Servicegroup
        targetLanguage:
          anyOf:
          - $ref: '#/components/schemas/InternalLanguageCodeEnum'
          - type: 'null'
      additionalProperties: false
      type: object
      required:
      - serviceType
      - serviceGroup
      - targetLanguage
      title: TranslationServiceEntry
    Response_OrderDetailWithItemsRead_:
      properties:
        message:
          type: string
          title: Message
          default: Operation successful
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
          - $ref: '#/components/schemas/OrderDetailWithItemsRead'
          - type: 'null'
        errors:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Errors
      type: object
      title: Response[OrderDetailWithItemsRead]
    OrderDetailRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        organizationId:
          type: string
          format: uuid
          title: Organizationid
        clientProjectId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientprojectid
        clientProjectName:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientprojectname
        status:
          $ref: '#/components/schemas/ExternalOrderStatus'
        itemsCount:
          type: integer
          title: Itemscount
          default: 0
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
      - id
      - organizationId
      - status
      - createdAt
      - updatedAt
      title: OrderDetailRead
      description: Slim order projection used by GET /orders.
    OrderCreate:
      properties:
        driveLinks:
          items:
            $ref: '#/components/schemas/DriveLinkCreate'
          type: array
          maxItems: 20
          title: Drivelinks
        defaults:
          $ref: '#/components/schemas/OrderDefaultsCreate'
        clientProjectId:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientprojectid
        clientProjectName:
          anyOf:
          - type: string
          - type: 'null'
          title: Clientprojectname
        services:
          items:
            oneOf:
            - $ref: '#/components/schemas/TranscriptServiceEntry'
            - $ref: '#/components/schemas/TranslationServiceEntry'
            - $ref: '#/components/schemas/InterpretationServiceEntry'
            discriminator:
              propertyName: serviceGroup
              mapping:
                interpretation: '#/components/schemas/InterpretationServiceEntry'
                transcript: '#/components/schemas/TranscriptServiceEntry'
                translation: '#/components/schemas/TranslationServiceEntry'
          type: array
          maxItems: 20
          minItems: 1
          title: Services
      additionalProperties: false
      type: object
      required:
      - services
      title: OrderCreate
    OrderIdResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
      type: object
      required:
      - id
      title: OrderIdResponse
      description: Slim response for the create endpoint — only the order id.
    WebhookDelivery:
      properties:
        templateFormat:
          anyOf:
          - $ref: '#/components/schemas/TemplateFormat'
          - type: 'null'
        templateId:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Templateid
        method:
          type: string
          const: WEBHOOK
          title: Method
          default: WEBHOOK
        callbackUrl:
          type: string
          maxLength: 500
          minLength: 1
          format: uri
          title: Callbackurl
        customHeaders:
          additionalProperties:
            type: string
          type: object
          title: Customheaders
      type: object
      required:
      - callbackUrl
      title: WebhookDelivery
      description: 'Inbound order contract for delivery to a public HTTPS webhook.


        Historical order/transcript callback JSON is not revalidated through this

        write schema. The delivery worker accepts that legacy shape but still sends

        only through the independently enforced public-HTTPS transport boundary.'
    EmailDelivery:
      properties:
        templateFormat:
          anyOf:
          - $ref: '#/components/schemas/TemplateFormat'
          - type: 'null'
        templateId:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Templateid
        method:
          type: string
          const: EMAIL
          title: Method
          default: EMAIL
        emails:
          items:
            type: string
            format: email
          type: array
          minItems: 1
          title: Emails
      type: object
      required:
      - emails
      title: EmailDelivery
      description: Deliver result via email.
    Response_OrderIdResponse_:
      properties:
        message:
          type: string
          title: Message
          default: Operation successful
        success:
          type: boolean
          title: Success
          default: true
        data:
          anyOf:
          - $ref: '#/components/schemas/OrderIdResponse'
          - type: 'null'
        errors:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Errors
      type: object
      title: Response[OrderIdResponse]
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    InterpretationVideoDetails:
      properties:
        channel:
          type: string
          const: REMOTE_VIDEO
          title: Channel
          default: REMOTE_VIDEO
        meetingUrl:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
          title: Meetingurl
        platform:
          type: string
          enum:
          - ZOOM
          - TEAMS
          - MEET
          - CADENCE
          - OTHER
          title: Platform
      additionalProperties: false
      type: object
      required:
      - meetingUrl
      - platform
      title: InterpretationVideoDetails
    TurnAroundTime:
      type: string
      enum:
      - 1 hour
      - 2 hours
      - 4 hours
      - 8 hours
      - 12 hours
      - 24 hours
      - 36 hours
      - 48 hours
      - 72 hours
      - 120 hours
      title: TurnAroundTime
    ExternalOrderStatus:
      type: string
      enum:
      - PENDING
      - COMPLETED
      - CANCELLED
      - REJECTED
      - IN_PROGRESS
      title: ExternalOrderStatus