Projects

Get project

Changed on
get/v2/workspaces/{workspace_id}/projects/{project_id}

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v2/workspaces/{workspace_id}/projects/{project_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.app.layer.ai/authorize, token URL https://auth.app.layer.ai/oauth/token)
    • OAuth 2 (client credentials, token URL https://api.app.layer.ai/api/oauth/token, scopes: projects:read)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

project_idstring uuid required

Id of the project.

Response

Successful Response

project_idstring uuid required

The project's unique identifier.

namestring required

The project's display name.

status'active' | 'archived' | 'deleted' required
object_countinteger required

Number of library objects currently linked to this project.

descriptionstring nullable

The project's long-form description, if set.

instructionsstring nullable

Project-specific instructions that guide content created within it, if set. Deprecated: attach a skill to the project instead. Honoured while it holds text, and read back as null once the project's instructions have been converted into a project-attached skill.

Changes

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2d86d473cda6Revision changes
    • info

      the endpoint scheme security serviceAccount was added to the API

    • info

      the security scope projects:read was removed from the endpoint's security scheme oauth2