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

# GET /api/projects/{projectKey}



## OpenAPI

````yaml /api/worksong.openapi.json get /api/projects/{projectKey}
openapi: 3.1.0
info:
  title: Worksong API
  version: 042e65d5f227
  description: >-
    The HTTP API behind the Worksong apps, generated from the code at the commit
    below. Request and response shapes come from the shared zod contract; an
    operation marked `x-gaps` has a part the generator could not resolve.
  x-source: worksong-ai/worksong@042e65d5f2275493f60f879c7970dcfdeceb7e0e
servers:
  - url: https://app.worksong.ai
security:
  - bearerAuth: []
tags:
  - name: Approvals
  - name: Audit
  - name: Avatar generator
  - name: Bootstrap
  - name: Bot compute limit
  - name: Bot mcp servers
  - name: Bots
  - name: Calls
  - name: Connections
  - name: Contacts
  - name: Conversations
  - name: Coupons
  - name: Day grants
  - name: Desktop
  - name: Entity files
  - name: Files
  - name: Github
  - name: Insights
  - name: Login
  - name: Mcp servers
  - name: Me
  - name: Me bot messaging
  - name: Me chat header
  - name: Me daily limit
  - name: Me time zone
  - name: Memory
  - name: Message delete
  - name: Messages
  - name: Notifications
  - name: Optimize prompt
  - name: Phone
  - name: Places
  - name: Projects
  - name: Public file links
  - name: Push
  - name: Queue
  - name: Reactions
  - name: Register
  - name: Rooms
  - name: Routes
  - name: Routines
  - name: Runs
  - name: Skills
  - name: Tasks
  - name: Transcribe
  - name: Tts
  - name: Webhooks
  - name: Whats new
  - name: Whatsapp
  - name: Workspace files
paths:
  /api/projects/{projectKey}:
    get:
      tags:
        - Projects
      summary: GET /api/projects/{projectKey}
      operationId: get_api_projects_projectKey
      parameters:
        - name: projectKey
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  key:
                    type: string
                    minLength: 1
                    maxLength: 120
                  conversations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        botId:
                          type: string
                          format: uuid
                        roomId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        kind:
                          type: string
                          minLength: 1
                          maxLength: 32
                        title:
                          type: string
                          maxLength: 200
                        lastActivityAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - botId
                        - roomId
                        - kind
                        - title
                        - lastActivityAt
                      additionalProperties: false
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        filename:
                          type: string
                          minLength: 1
                          maxLength: 255
                        mimeType:
                          type: string
                          minLength: 1
                          maxLength: 128
                        byteSize:
                          type: integer
                          minimum: 0
                          maximum: 9007199254740991
                        available:
                          type: boolean
                        createdAt:
                          type: string
                          format: date-time
                        origin:
                          default: upload
                          type: string
                          enum:
                            - upload
                            - agent
                        sha256:
                          default: null
                          anyOf:
                            - type: string
                              pattern: ^[0-9a-f]{64}$
                            - type: 'null'
                        savedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - filename
                        - mimeType
                        - byteSize
                        - available
                        - createdAt
                        - origin
                        - sha256
                        - savedAt
                      additionalProperties: false
                  memories:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        scope:
                          type: string
                          enum:
                            - bot
                            - user
                            - project
                            - room
                        botId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        roomId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        projectKey:
                          anyOf:
                            - type: string
                              maxLength: 120
                            - type: 'null'
                        whatsappJid:
                          anyOf:
                            - type: string
                              maxLength: 128
                              pattern: >-
                                ^[0-9A-Za-z._:-]{1,100}@(s\.whatsapp\.net|g\.us|lid)$
                            - type: 'null'
                        whatsappPersonName:
                          anyOf:
                            - type: string
                              minLength: 1
                              maxLength: 200
                            - type: 'null'
                        content:
                          type: string
                          maxLength: 200000
                        createdBy:
                          type: string
                          enum:
                            - user
                            - agent
                            - system
                        createdByBotId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        sourceConversationId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        sourceRunId:
                          anyOf:
                            - type: string
                              format: uuid
                            - type: 'null'
                        version:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - scope
                        - botId
                        - roomId
                        - projectKey
                        - whatsappJid
                        - whatsappPersonName
                        - content
                        - createdBy
                        - createdByBotId
                        - sourceConversationId
                        - sourceRunId
                        - version
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                required:
                  - key
                  - conversations
                  - files
                  - memories
                additionalProperties: false
        4XX:
          description: Error. A problem object with a status and a message.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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