Projects

Create project

Changed on
post/v1/workspaces/{workspace_id}/projects

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v1/workspaces/{workspace_id}/projects
  • 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:write)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request body

namestring required

The project's display name. Must be unique within the workspace.

descriptionstring nullable
instructionsstring nullable

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.

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:write was removed from the endpoint's security scheme oauth2