openapi.documented.yml

openapi: 3.1.0
info:
    title: Developer API
    description: Tembo Developer API
    version: 1.0.0
servers:
    - url: https://api.tembo.io/
      description: Tembo API
components:
    securitySchemes:
        apiKeyAuth:
            type: apiKey
            in: header
            name: Authorization
    schemas: {}
paths:
    /task/create:
        post:
            responses:
                "200":
                    description: Task created successfully
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    id:
                                        type: string
                                        format: uuid
                                    title:
                                        type: string
                                    description:
                                        type: string
                                    status:
                                        type: string
                                    createdAt:
                                        type: string
                                        format: date-time
                                    updatedAt:
                                        type: string
                                        format: date-time
                                    organizationId:
                                        type: string
                                        format: uuid
                                    htmlUrl:
                                        type: string
                                        format: uri
                                        description: URL to view this task in the Tembo web application
                                        example: https://app.tembo.io/tasks/123e4567-e89b-12d3-a456-426614174000
                                required:
                                    - id
                                    - title
                                    - description
                                    - status
                                    - createdAt
                                    - updatedAt
                                    - organizationId
                                    - htmlUrl
                "400":
                    description: Bad request - invalid input or missing organization ID
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                required:
                                    - error
                "500":
                    description: Internal server error
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                required:
                                    - error
            operationId: postPublic-apiTaskCreate
            parameters: []
            description: Create a task for tembo to start working on in the background
            summary: Create Task
            requestBody:
                description: Task creation payload
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                prompt:
                                    type: string
                                    minLength: 1
                                    description: Description of the task to be performed. Supports tagging files.
                                    example: Fix the authentication bug in the login component
                                description:
                                    type: string
                                    minLength: 1
                                    description: Detailed description of the task (alternative to prompt)
                                    example: Users are reporting they cannot log in. JWT token validation appears to be failing.
                                agent:
                                    type: string
                                    description: The agent to use for this task
                                    example: claudeCode:claude-opus-4-5
                                repositories:
                                    type: array
                                    items:
                                        type: string
                                    description: Array of code repository urls that this task relates to
                                    example:
                                        - https://github.com/org/repo
                                        - https://gitlab.com/org/repo-2
                                codeRepoIds:
                                    type: array
                                    items:
                                        type: string
                                    description: Array of Tembo code repository IDs to target directly
                                    example:
                                        - cbad4334-c844-4fef-a8da-d08f209f267e
                                        - 6307d53a-b99d-4e90-ab89-f29114f33d53
                                targetBranch:
                                    type: string
                                    nullable: true
                                    description: The branch to open the pull request against (e.g. main, develop)
                                    example: main
                                branchName:
                                    type: string
                                    nullable: true
                                    description: The branch name to use for the work
                                    example: feature/auth-fix
                                queueRightAway:
                                    type: boolean
                                    nullable: true
                                    default: true
                                    description: Whether to immediately queue the task for processing (optional, defaults to true)
                                    example: false
                            anyOf:
                                - required:
                                      - prompt
                                - required:
                                      - description
                required: true
            x-codeSamples:
                - lang: JavaScript
                  source: |-
                      import Tembo from '@tembo-io/sdk';

                      const client = new Tembo({
                        apiKey: 'My API Key',
                      });

                      const task = await client.task.create({
                        prompt: 'Fix the authentication bug in the login component',
                        agent: 'claudeCode:claude-opus-4-5',
                        repositories: [
                          'https://github.com/org/repo',
                          'https://gitlab.com/org/repo-2',
                        ],
                        targetBranch: 'dev',
                        branchName: "cooper-is-awesome",
                      });

                      console.log(task.id);
    /task/list:
        get:
            responses:
                "200":
                    description: Successfully retrieved paginated list of issues
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    issues:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                                title:
                                                    type: string
                                                description:
                                                    type: string
                                                status:
                                                    type: string
                                                createdAt:
                                                    type: string
                                                    format: date-time
                                                updatedAt:
                                                    type: string
                                                    format: date-time
                                                organizationId:
                                                    type: string
                                                    format: uuid
                                                htmlUrl:
                                                    type: string
                                                    format: uri
                                                    description: URL to view this task in the Tembo web application
                                                    example: https://app.tembo.io/tasks/123e4567-e89b-12d3-a456-426614174000
                                            required:
                                                - id
                                                - title
                                                - description
                                                - status
                                                - createdAt
                                                - updatedAt
                                                - organizationId
                                                - htmlUrl
                                    meta:
                                        type: object
                                        properties:
                                            totalCount:
                                                type: integer
                                            totalPages:
                                                type: integer
                                            currentPage:
                                                type: integer
                                            pageSize:
                                                type: integer
                                            hasNext:
                                                type: boolean
                                            hasPrevious:
                                                type: boolean
                                        required:
                                            - totalCount
                                            - totalPages
                                            - currentPage
                                            - pageSize
                                            - hasNext
                                            - hasPrevious
                                required:
                                    - issues
                                    - meta
            operationId: getPublic-apiTaskList
            parameters:
                - name: limit
                  in: query
                  description: Number of items to return per page (max 100)
                  required: false
                  schema:
                      type: integer
                      minimum: 1
                      maximum: 100
                      default: 10
                      example: 10
                - name: page
                  in: query
                  description: Page number to retrieve (starts from 1)
                  required: false
                  schema:
                      type: integer
                      minimum: 1
                      default: 1
                      example: 1
            description: Gets a paginated list of issues for the organization
            summary: List Tasks
            x-codeSamples:
                - lang: JavaScript
                  source: |-
                      import Tembo from '@tembo-io/sdk';

                      const client = new Tembo({
                        apiKey: 'My API Key',
                      });

                      const tasks = await client.task.list();

                      console.log(tasks.issues);
    /task/search:
        get:
            responses:
                "200":
                    description: Successfully retrieved search results with pagination
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    issues:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                                title:
                                                    type: string
                                                description:
                                                    type: string
                                                status:
                                                    type: string
                                                createdAt:
                                                    type: string
                                                    format: date-time
                                                updatedAt:
                                                    type: string
                                                    format: date-time
                                                organizationId:
                                                    type: string
                                                    format: uuid
                                                htmlUrl:
                                                    type: string
                                                    format: uri
                                                    description: URL to view this task in the Tembo web application
                                                    example: https://app.tembo.io/tasks/123e4567-e89b-12d3-a456-426614174000
                                            required:
                                                - id
                                                - title
                                                - description
                                                - status
                                                - createdAt
                                                - updatedAt
                                                - organizationId
                                                - htmlUrl
                                    meta:
                                        type: object
                                        properties:
                                            totalCount:
                                                type: integer
                                            totalPages:
                                                type: integer
                                            currentPage:
                                                type: integer
                                            pageSize:
                                                type: integer
                                            hasNext:
                                                type: boolean
                                            hasPrevious:
                                                type: boolean
                                        required:
                                            - totalCount
                                            - totalPages
                                            - currentPage
                                            - pageSize
                                            - hasNext
                                            - hasPrevious
                                    query:
                                        type: string
                                required:
                                    - issues
                                    - meta
                                    - query
                "400":
                    description: Bad request - invalid search query or missing organization ID
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                required:
                                    - error
            operationId: getPublic-apiTaskSearch
            parameters:
                - name: q
                  in: query
                  description: Search query to find issues by title or description
                  required: true
                  schema:
                      type: string
                      minLength: 1
                      example: authentication bug
                - name: limit
                  in: query
                  description: Number of items to return per page (max 100)
                  required: false
                  schema:
                      type: integer
                      minimum: 1
                      maximum: 100
                      default: 10
                      example: 10
                - name: page
                  in: query
                  description: Page number to retrieve (starts from 1)
                  required: false
                  schema:
                      type: integer
                      minimum: 1
                      default: 1
                      example: 1
            description: Search issues for the organization with pagination
            summary: Search Tasks
            x-codeSamples:
                - lang: JavaScript
                  source: |-
                      import Tembo from '@tembo-io/sdk';

                      const client = new Tembo({
                        apiKey: 'My API Key',
                      });

                      const response = await client.task.search({ q: 'authentication bug' });

                      console.log(response.issues);
    /automation/{slug}/trigger:
        post:
            responses:
                "200":
                    description: Automation triggered successfully
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    id:
                                        type: string
                                        format: uuid
                                        description: Unique identifier for the queued job
                                    task:
                                        type: string
                                        description: The type of job that was queued
                                        example: RunWorkflow
                                    status:
                                        type: string
                                        description: Current status of the job
                                        example: pending
                                    priority:
                                        type: integer
                                        description: Job priority
                                        example: 5
                                    createdAt:
                                        type: string
                                        format: date-time
                                    updatedAt:
                                        type: string
                                        format: date-time
                                required:
                                    - id
                                    - task
                                    - status
                                    - priority
                                    - createdAt
                                    - updatedAt
                "404":
                    description: Automation not found (no automation with the given key exists in your organization)
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: Automation not found
                                required:
                                    - error
            operationId: postPublic-apiAutomationTrigger
            parameters:
                - name: slug
                  in: path
                  description: The slug of the automation to trigger. Set in the automation's properties panel.
                  required: true
                  schema:
                      type: string
                      example: myAutomation
            description: Trigger an automation with an arbitrary JSON payload, which is passed to the automation as event context. Only automations with a slug set can be triggered.
            summary: Trigger Automation
            requestBody:
                description: Arbitrary JSON payload passed to the automation as event context. Your automation instructions can reference any values in this payload.
                content:
                    application/json:
                        schema:
                            type: object
                            additionalProperties: true
                            example:
                                issue_url: https://github.com/org/repo/issues/42
                                priority: high
                required: false
            x-codeSamples:
                - lang: bash
                  source: |-
                      curl -X POST https://api.tembo.io/automation/myAutomation/trigger \
                        -H "Authorization: Bearer YOUR_API_KEY" \
                        -H "Content-Type: application/json" \
                        -d '{"issue_url": "https://github.com/org/repo/issues/42"}'
    /repository/list:
        get:
            responses:
                "200":
                    description: Successfully retrieved list of enabled code repositories
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    codeRepositories:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                                    description: Unique identifier for the code repository
                                                    example: 123e4567-e89b-12d3-a456-426614174000
                                                name:
                                                    type: string
                                                    description: Name of the repository
                                                    example: my-awesome-project
                                                url:
                                                    type: string
                                                    format: uri
                                                    description: Repository URL
                                                    example: https://github.com/username/my-awesome-project
                                                branch:
                                                    type: string
                                                    description: Default branch name
                                                    example: main
                                                description:
                                                    type: string
                                                    description: Repository description
                                                    example: An awesome web application built with React
                                                enabledAt:
                                                    type: string
                                                    format: date-time
                                                    description: Timestamp when the repository was enabled
                                                    example: "2023-12-01T10:30:00.000Z"
                                                createdAt:
                                                    type: string
                                                    format: date-time
                                                    description: Timestamp when the repository record was created
                                                    example: "2023-12-01T09:15:00.000Z"
                                                updatedAt:
                                                    type: string
                                                    format: date-time
                                                    description: Timestamp when the repository record was last updated
                                                    example: "2023-12-01T11:45:00.000Z"
                                                organizationId:
                                                    type: string
                                                    format: uuid
                                                    description: Organization ID that owns this repository
                                                    example: 456e7890-e89b-12d3-a456-426614174001
                                                integration:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                            description: Unique identifier for the integration
                                                            example: 123e4567-e89b-12d3-a456-426614174000
                                                        type:
                                                            type: string
                                                            description: Type of integration (e.g., github, gitlab)
                                                            example: github
                                                        name:
                                                            type: string
                                                            description: Name of the integration
                                                            example: GitHub Integration
                                                        configuration:
                                                            type: object
                                                            additionalProperties:
                                                                {}
                                                            description: Integration configuration settings
                                                    required:
                                                        - id
                                                        - type
                                                        - name
                                                        - configuration
                                                    description: Associated integration details
                                            required:
                                                - id
                                                - name
                                                - enabledAt
                                                - createdAt
                                                - updatedAt
                                                - organizationId
                                        description: Array of enabled code repositories for the organization
                                required:
                                    - codeRepositories
                "400":
                    description: Bad request - missing organization ID
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    error:
                                        type: string
                                        example: Organization ID is required
                                required:
                                    - error
            operationId: getPublic-apiRepositoryList
            parameters: []
            description: Gets a list of enabled repositories for the organization
            summary: List Repositories
            x-codeSamples:
                - lang: JavaScript
                  source: |-
                      import Tembo from '@tembo-io/sdk';

                      const client = new Tembo({
                        apiKey: 'My API Key',
                      });

                      const repositories = await client.repository.list();

                      console.log(repositories.codeRepositories);