Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Create project

admin.organization.projects.create(**kwargs) -> Project { id, created_at, object, 5 more }
POST
/organization/projects

Create a new project in the organization. Projects can be created and archived, but cannot be deleted.

Parameters
name: String

The friendly name of the project, this name appears in reports.

external_key_id: String

External key ID to associate with the project.

geography: String

Deprecated.

Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See data residency controls to review the functionality and limitations of setting this field. Deprecated: use residency instead. Do not provide both geography and residency.

residency: ProjectResidency

Create the project with the specified residency configuration. Your organization must have access to the requested residency configuration in order to use it. See data residency controls to review the functionality and limitations of setting this field.

Returns
class Project { id, created_at, object, 5 more }

Represents an individual project.

id: String

The identifier, which can be referenced in API endpoints

created_at: Integer

The Unix timestamp (in seconds) of when the project was created.

formatunixtime
object: :"organization.project"

The object type, which is always organization.project

archived_at: Integer

The Unix timestamp (in seconds) of when the project was archived or null.

formatunixtime
external_key_id: String

The external key associated with the project.

name: String

The name of the project. This appears in reporting.

residency: ProjectResidency

The residency configuration for the project.

status: String

active or archived

Create project

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

project = openai.admin.organization.projects.create(name: "name")

puts(project)
{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project ABC",
    "created_at": 1711471533,
    "archived_at": null,
    "status": "active"
}
Returns Examples
{
    "id": "proj_abc",
    "object": "organization.project",
    "name": "Project ABC",
    "created_at": 1711471533,
    "archived_at": null,
    "status": "active"
}