Treasure Data Project API

openapi: 3.2.0
info:
  title: Treasure Data Project API
  version: '1.0'
  description: 'Operations tagged Project across 2 of this provider''s published API definitions: treasure-data-llm-api-openapi.yml, treasure-data-workflow-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://llm-api.treasuredata.com
- url: https://llm-api.eu01.treasuredata.com
- url: https://llm-api.ap02.treasuredata.com
- url: https://llm-api.treasuredata.co.jp
- description: aws
  url: https://api-workflow.treasuredata.com
- description: aws-tokyo
  url: https://api-workflow.treasuredata.co.jp
- description: eu01
  url: https://api-workflow.eu01.treasuredata.com
- description: ap02
  url: https://api-workflow.ap02.treasuredata.com
- description: ap03
  url: https://api-workflow.ap03.treasuredata.com
security:
- ApiKeyAuth: []
tags:
- name: Project
paths:
  /api/projects:
    get:
      summary: index
      tags:
      - Project
      responses:
        '200':
          description: allows GET /api/projects
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                        links:
                          type: object
                          properties:
                            self:
                              type: string
                          required:
                          - self
                        attributes:
                          type: object
                          properties:
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                            name:
                              type: string
                            description: {}
                            useRuntimeTextResource:
                              type: boolean
                            useParentSegment:
                              type: boolean
                            useWorkflowExecutor:
                              type: boolean
                            isManaged:
                              type: boolean
                            managedType:
                              type: string
                          required:
                          - createdAt
                          - updatedAt
                          - name
                          - description
                          - useRuntimeTextResource
                          - useParentSegment
                          - useWorkflowExecutor
                          - isManaged
                          - managedType
                        relationships:
                          type: object
                          properties:
                            overview:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                              required:
                              - data
                            createdBy:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                              required:
                              - data
                            updatedBy:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                              required:
                              - data
                            formInterfaces:
                              type: object
                              properties:
                                data:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      type:
                                        type: string
                                      id:
                                        type: string
                                    required:
                                    - type
                                    - id
                              required:
                              - data
                            chatInterfaces:
                              type: object
                              properties:
                                data:
                                  type: array
                                  items: {}
                              required:
                              - data
                      required:
                      - id
                      - type
                      - links
                      - attributes
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                    required:
                    - total
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                      last:
                        type: string
                    required:
                    - first
                    - last
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                        attributes:
                          type: object
                          properties:
                            firstAgentName:
                              type: string
                            firstIntegrationServiceType:
                              type: string
                            firstKnowledgeBaseName:
                              type: string
                            totalAgentCount:
                              type: integer
                            totalIntegrationCount:
                              type: integer
                            totalKnowledgeBaseCount:
                              type: integer
                            name:
                              type: string
                            email:
                              type: string
                            createdAt:
                              type: string
                            updatedAt:
                              type: string
                            projectId:
                              type: string
                            agentId:
                              type:
                              - string
                              - 'null'
                            promptTemplate:
                              type:
                              - string
                              - 'null'
                            formJsonSchema:
                              type:
                              - string
                              - 'null'
                            formUiSchema: {}
                            useTextResource:
                              type:
                              - boolean
                              - 'null'
                            starterMessage:
                              type:
                              - string
                              - 'null'
                            textInputEnabled:
                              type:
                              - boolean
                              - 'null'
                            textInputAgentId: {}
                            isManaged:
                              type:
                              - boolean
                              - 'null'
                            chatInterfaceButtons:
                              type:
                              - array
                              - 'null'
                              items: {}
                        links:
                          type: object
                          properties:
                            self:
                              type: string
                          required:
                          - self
                        relationships:
                          type:
                          - object
                          - 'null'
                          properties:
                            project:
                              type: object
                              properties:
                                data:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                              required:
                              - data
                          required:
                          - project
                      required:
                      - id
                      - type
                      - attributes
                required:
                - data
                - meta
                - links
              example:
                data:
                - id: 00000000-0000-0000-0000-000000000001
                  type: projects
                  links:
                    self: http://www.example.com/api/projects/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    name: cefwatpd
                    description: null
                    useRuntimeTextResource: false
                    useParentSegment: false
                    useWorkflowExecutor: false
                    isManaged: true
                    managedType: PARENT_SEGMENT
                meta:
                  total: 1
                links:
                  first: http://www.example.com/api/projects?page%5Blimit%5D=20&page%5Boffset%5D=0
                  last: http://www.example.com/api/projects?page%5Blimit%5D=20&page%5Boffset%5D=0
                included:
                - id: 00000000-0000-0000-0000-000000000001
                  type: formInterfaces
                  links:
                    self: http://www.example.com/api/form_interfaces/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    agentId: 00000000-0000-0000-0000-000000000001
                    name: ffyhntyh
                    promptTemplate: 'This is a test prompt template that parses arguments. subject: {{subject}}. topic: {{topic}}.'
                    formJsonSchema: '{"type":"object","properties":{"subject":{"type":"string","title":"Subject"},"topic":{"title":"Topic","type":"string"}},"required":[]}'
                    formUiSchema: null
                    useTextResource: false
                  relationships:
                    project:
                      data:
                        type: projects
                        id: 00000000-0000-0000-0000-000000000001
                - id: 00000000-0000-0000-0000-000000000001
                  type: formInterfaces
                  links:
                    self: http://www.example.com/api/form_interfaces/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    agentId: 00000000-0000-0000-0000-000000000001
                    name: gkqnpzio
                    promptTemplate: 'This is a test prompt template that parses arguments. subject: {{subject}}. topic: {{topic}}.'
                    formJsonSchema: '{"type":"object","properties":{"subject":{"type":"string","title":"Subject"},"topic":{"title":"Topic","type":"string"}},"required":[]}'
                    formUiSchema: null
                    useTextResource: false
                  relationships:
                    project:
                      data:
                        type: projects
                        id: 00000000-0000-0000-0000-000000000001
                - id: 00000000-0000-0000-0000-000000000001
                  type: chatInterfaces
                  links:
                    self: http://www.example.com/api/chat_interfaces/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    name: vznhgcqt
                    starterMessage: ''
                    textInputEnabled: false
                    textInputAgentId: null
                    isManaged: false
                    chatInterfaceButtons: []
                - id: 00000000-0000-0000-0000-000000000001
                  type: chatInterfaces
                  links:
                    self: http://www.example.com/api/chat_interfaces/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    projectId: 00000000-0000-0000-0000-000000000001
                    name: fytqacsk
                    starterMessage: ''
                    textInputEnabled: false
                    textInputAgentId: null
                    isManaged: false
                    chatInterfaceButtons: []
        '401':
          description: Rejected by 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
      parameters:
      - name: filter[fulltext]
        in: query
        required: false
        schema:
          type: string
        example: nothing
      - name: filter[hasInterfaces]
        in: query
        required: false
        schema:
          type: string
        example: form,chat
      - name: filter[has_form_interfaces]
        in: query
        required: false
        schema:
          type: string
        example: 'false'
      - name: filter[is_managed]
        in: query
        required: false
        schema:
          type: string
        example: 'false'
      - name: filter[manage_type]
        in: query
        required: false
        schema:
          type: string
        example: PARENT_SEGMENT,PACKAGE
      - name: include
        in: query
        required: false
        schema:
          type: string
        example: formInterfaces,chatInterfaces
      - name: sort
        in: query
        required: false
        schema:
          type: string
        example: id
    post:
      summary: create
      tags:
      - Project
      responses:
        '201':
          description: creates a project with useWorkflowExecutor set to true
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                        required:
                        - self
                      attributes:
                        type: object
                        properties:
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          name:
                            type: string
                          description:
                            type:
                            - string
                            - 'null'
                          useRuntimeTextResource:
                            type: boolean
                          useParentSegment:
                            type: boolean
                          useWorkflowExecutor:
                            type: boolean
                          isManaged:
                            type: boolean
                          managedType:
                            type: string
                        required:
                        - createdAt
                        - updatedAt
                        - name
                        - description
                        - useRuntimeTextResource
                        - useParentSegment
                        - useWorkflowExecutor
                        - isManaged
                        - managedType
                    required:
                    - id
                    - type
                    - links
                    - attributes
                required:
                - data
              example:
                data:
                  id: 00000000-0000-0000-0000-000000000001
                  type: projects
                  links:
                    self: http://www.example.com/api/projects/00000000-0000-0000-0000-000000000001
                  attributes:
                    createdAt: '2025-05-01T05:05:14.000Z'
                    updatedAt: '2025-05-01T05:05:14.000Z'
                    name: workflow_project
                    description: project with workflow executor
                    useRuntimeTextResource: false
                    useParentSegment: false
                    useWorkflowExecutor: true
                    isManaged: false
                    managedType: NONE
        '400':
          description: rejects POST /api/projects
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        status:
                          type: string
                      required:
                      - title
                      - detail
                      - code
                      - status
                required:
                - errors
              example:
                errors:
                - title: Param not allowed
                  detail: managedType is not allowed.
                  code: '105'
                  status: '400'
        '401':
          description: Rejected by 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
        '422':
          description: Validation error - invalid or conflicting parameters provided
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        source:
                          type: object
                          properties:
                            pointer:
                              type: string
                          required:
                          - pointer
                        status:
                          type: string
                        meta:
                          type: object
                          properties:
                            validationCode:
                              type: string
                          required:
                          - validationCode
                      required:
                      - title
                      - detail
                      - code
                      - source
                      - status
                      - meta
                required:
                - errors
              example:
                errors:
                - title: has already been taken
                  detail: name - has already been taken
                  code: '100'
                  source:
                    pointer: /data/attributes/name
                  status: '422'
                  meta:
                    validationCode: VIOLATES_UNIQUENESS_CONSTRAINT
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                    attributes:
                      type: object
                      properties:
                        name:
                          type: string
                        description:
                          type: string
                        useRuntimeTextResource:
                          type: boolean
                        useWorkflowExecutor:
                          type: boolean
                      required:
                      - name
                  required:
                  - type
                  - attributes
              required:
              - data
            example:
              data:
                type: projects
                attributes:
                  name: workflow_project
                  description: project with workflow executor
                  useRuntimeTextResource: true
                  useWorkflowExecutor: true
    put:
      operationId: putProject
      parameters:
      - description: project name
        in: query
        name: project
        required: true
        schema:
          type: string
      - description: revision
        in: query
        name: revision
        required: true
        schema:
          type: string
      - in: header
        name: Content-Length
        schema:
          type: integer
          format: int64
      - description: start scheduling of new workflows from the given time instead of current time
        in: query
        name: schedule_from
        schema:
          type: string
      - description: clear_schedule
        in: query
        name: clear_schedule
        schema:
          type: array
          items:
            type: string
      - description: clear_schedule_all
        in: query
        name: clear_schedule_all
        schema:
          type: boolean
          default: false
      - description: skip schedules to current time for workflows whose schedule definition changed. Ignored when clear_schedule or clear_schedule_all is specified.
        in: query
        name: skip_schedule
        schema:
          type: boolean
          default: true
      requestBody:
        content:
          application/gzip:
            schema:
              type: string
              format: binary
        description: project archive data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestProject'
          description: default response
      summary: Upload a project archive as a new project or a new revision of an existing project
      tags:
      - Project
    servers:
    - url: https://llm-api.treasuredata.com
    - url: https://llm-api.eu01.treasuredata.com
    - url: https://llm-api.ap02.treasuredata.com
    - url: https://llm-api.treasuredata.co.jp
  /api/projects/{id}:
    delete:
      summary: destroy
      tags:
      - Project
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000001
      responses:
        '204':
          description: Project deleted successfully
        '401':
          description: Unauthorized - authentication credentials are missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '401'
                error: User credentials aren't set on the request
        '403':
          description: Forbidden - insufficient permissions to delete this project
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  error:
                    type: string
                required:
                - status
                - error
              example:
                status: '403'
                error: Forbidden
        '404':
          description: Project not found
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        detail:
                          type: string
                        code:
                          type: string
                        status:
                          type: string
                      required:
                      - title
                      - detail
                      - code
                      - status
                required:
                - errors
              example:
                errors:
                - title: Record not found
                  detail: The record identified by 00000000-0000-0000-0000-000000000001 could not be found.
                  code: '404'
                  status: '404'
    get:
      summary: show
      tags:
      - Project
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        example: 00000000-0000-0000-0000-000000000001
      - name: include
        in: query
        required: false
        schema:
          type: string
        example: formInterfaces.createdBy,formInterfaces.updatedBy,chatInterfaces.createdBy,chatInterfaces.updatedBy
      responses:
        '200':
          description: allows GET /api/projects/:id
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                      links:
                        type: object
                        properties:
                          self:
                            type: string
                        required:
                        - self
                      attributes:
                        type: object
                        properties:
                          createdAt:
                            type: string
                          updatedAt:
                            type: string
                          name:
                            type: string
                          description: {}
                          useRuntimeTextResource:
                            type: boolean
                          useParentSegment:
                            type: boolean
                          useWorkflowExecutor:
                            type: boolean
                          isManaged:
                            type: boolean
                          managedType:
                            type: string
                        required:
                        - createdAt
                        - updatedAt
                        - name
                        - description
                        - useRuntimeTextResource
                        - useParentSegment
                        - useWorkflowExecutor
                        - isManaged
                        - managedType
                      relationships:
                        type: object
                        properties:
                          formInterfaces:
                            type: object
                            properties:
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                                  - id
                            required:
                            - data
                          chatInterfaces:
                            type: object
                            properties:
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    type:
                                      type: string
                                    id:
                                      type: string
                                  required:
                                  - type
                      

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/treasure-data/refs/heads/main/openapi/treasure-data-project-api-openapi.yml