The project create request payload.
ProjectCreateRequest
namestringrequired
The friendly name of the project, this name appears in reports.
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
post
https://api.openai.com/v1/organization/projects
Body
application/json
Body
application/json
Response
200 application/json
Response
200 application/json
Project created successfully.
Project
Represents an individual project.
idstringrequired
The identifier, which can be referenced in API endpoints
objectstringrequired
The object type, which is always organization.project
Allowed values:organization.project
namestringrequired
The name of the project. This appears in reporting.
created_atintegerrequired
The Unix timestamp (in seconds) of when the project was created.
archived_atinteger | null
The Unix timestamp (in seconds) of when the project was archived or null.
statusstringrequired
active or archived
Allowed values:activearchived
post/organization/projects
Authentication
Body
{
"name": "name"
}
200 application/json
Retrieves a project.
get
https://api.openai.com/v1/organization/projects/{project_id}
Path Parameters
project_idstringrequired
The ID of the project.
Response
200 application/json
Response
200 application/json
Project retrieved successfully.
Project
Represents an individual project.
idstringrequired
The identifier, which can be referenced in API endpoints
objectstringrequired
The object type, which is always organization.project
Allowed values:organization.project
namestringrequired
The name of the project. This appears in reporting.
created_atintegerrequired
The Unix timestamp (in seconds) of when the project was created.
archived_atinteger | null
The Unix timestamp (in seconds) of when the project was archived or null.
statusstringrequired
active or archived
Allowed values:activearchived
get/organization/projects/{project_id}
Authentication
Path Parameters
200 application/json
Modifies a project in the organization.
post
https://api.openai.com/v1/organization/projects/{project_id}
Path Parameters
project_idstringrequired
The ID of the project.
Body
application/json
Body
application/json
The project update request payload.
ProjectUpdateRequest
namestringrequired
The updated name of the project, this name appears in reports.
Response
application/json
Response
application/json
Project updated successfully.
Project
Represents an individual project.
idstringrequired
The identifier, which can be referenced in API endpoints
objectstringrequired
The object type, which is always organization.project
Allowed values:organization.project
namestringrequired
The name of the project. This appears in reporting.
created_atintegerrequired
The Unix timestamp (in seconds) of when the project was created.
archived_atinteger | null
The Unix timestamp (in seconds) of when the project was archived or null.
statusstringrequired
active or archived
Allowed values:activearchived
post/organization/projects/{project_id}
Authentication
Path Parameters
Body
{
"name": "name"
}
application/json
Returns a list of API keys in the project.
get
https://api.openai.com/v1/organization/projects/{project_id}/api_keys
Query Parameters
limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
Default:20
afterstring
A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
Path Parameters
project_idstringrequired
The ID of the project.
Response
200 application/json
Response
200 application/json
Project API keys listed successfully.
ProjectApiKeyListResponse
objectstringrequired
Allowed values:list
dataarray[object]required
Represents an individual API key in a project.
Show Child Parameters
first_idstringrequired
last_idstringrequired
has_morebooleanrequired
get/organization/projects/{project_id}/api_keys
Authentication
Path Parameters
Query Parameters
200 application/json
Retrieves an API key in the project.
get
https://api.openai.com/v1/organization/projects/{project_id}/api_keys/{key_id}
Path Parameters
project_idstringrequired
The ID of the project.
key_idstringrequired
The ID of the API key.
Response
200 application/json
Response
200 application/json
Project API key retrieved successfully.
ProjectApiKey
Represents an individual API key in a project.
objectstringrequired
The object type, which is always organization.project.api_key
Allowed values:organization.project.api_key
redacted_valuestringrequired
The redacted value of the API key
namestringrequired
The name of the API key
created_atintegerrequired
The Unix timestamp (in seconds) of when the API key was created
idstringrequired
The identifier, which can be referenced in API endpoints
ownerobjectrequired
Show Child Parameters
get/organization/projects/{project_id}/api_keys/{key_id}
Authentication
Path Parameters
200 application/json