Projects

Create a project

Creates a project in the organization your credential acts on.

With a user-delegated token the project lands in the workspace named by workspace_id, which must be one the token reaches, or in the organization's default workspace when none is named. A partner's project always lands in the default workspace. The response reports where it landed. A request is refused when the workspace it would land in is out of the credential's reach.

With a user-delegated token the project is owned by the token's person. A partner request carries no acting person, so ownership is left empty and the project's history records the assertion that created it instead.

Not idempotent: repeating the call creates a second project. Refused once the organization reaches the project limit or the answered-questions allowance on its plan, while the organization is suspended, and on a plan that does not include authoring studies.

Requires the projects:write scope, on a user-delegated token or a partner credential.

post/v2/projects/

Request

  • Base URL: https://api.outset.ai
  • URL: https://api.outset.ai/v2/projects/
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://outset.ai/oauth/authorize, token URL https://api.outset.ai/users/oauth/token/, scopes: projects:write)
    • HTTP bearer

Request body

namestring required

Project name, as its researchers will see it.

workspace_idstring uuid

The workspace to create the project in, for a user-delegated token: one the token reaches, as GET /v2/me/ lists them. Omit it to use the organization's default workspace. Ignored for a partner, whose projects always land in the default workspace.

interview_method'STANDARD' | 'USABILITY'
  • STANDARD - STANDARD
  • USABILITY - USABILITY

Response

Changes

No recorded changes to this operation across all 1 revision of this API.