OpenAI API (unofficial showcase)
POST/organization/projects

Create project

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

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

The project create request payload.

namestringrequired
The friendly name of the project, this name appears in reports.
geographystringdeprecatedoptional
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](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. Deprecated: use `residency` instead. Do not provide both `geography` and `residency`.
residencystringoptional
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](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.
Allowed:GLOBALUS_STORAGE_PROCESSINGEU_STORAGE_PROCESSINGJP_STORAGEJP_STORAGE_PROCESSINGKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEIN_STORAGE_PROCESSINGAU_STORAGEAU_STORAGE_PROCESSING
external_key_idstringoptional
External key ID to associate with the project.

5 status codes
200Project created successfully.
idstringrequired
The identifier, which can be referenced in API endpoints
objectstringrequired
The object type, which is always `organization.project`
Allowed:organization.project
namestringoptional
The name of the project. This appears in reporting.
created_atintegerrequired
The Unix timestamp (in seconds) of when the project was created.
archived_atintegeroptional
The Unix timestamp (in seconds) of when the project was archived or `null`.
statusstringoptional
`active` or `archived`
external_key_idstringoptional
The external key associated with the project.
residencystringoptional
The residency configuration for the project.
Allowed:GLOBALUS_STORAGE_PROCESSINGEU_STORAGE_PROCESSINGJP_STORAGEJP_STORAGE_PROCESSINGKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEIN_STORAGE_PROCESSINGAU_STORAGEAU_STORAGE_PROCESSING
201Project created successfully.
idstringrequired
The identifier, which can be referenced in API endpoints
objectstringrequired
The object type, which is always `organization.project`
Allowed:organization.project
namestringoptional
The name of the project. This appears in reporting.
created_atintegerrequired
The Unix timestamp (in seconds) of when the project was created.
archived_atintegeroptional
The Unix timestamp (in seconds) of when the project was archived or `null`.
statusstringoptional
`active` or `archived`
external_key_idstringoptional
The external key associated with the project.
residencystringoptional
The residency configuration for the project.
Allowed:GLOBALUS_STORAGE_PROCESSINGEU_STORAGE_PROCESSINGJP_STORAGEJP_STORAGE_PROCESSINGKR_STORAGECA_STORAGESG_STORAGEIN_STORAGEIN_STORAGE_PROCESSINGAU_STORAGEAU_STORAGE_PROCESSING
400The project creation request is invalid or contains incompatible settings.
errorobjectrequired
403The caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
429Too many management requests. Reduce the request rate and try again later.
errorobjectrequired

Error handling

A 400 is returned: The project creation request is invalid or contains incompatible settings. A 403 is returned: The caller does not have permission to perform this operation. A 429 is returned: Too many management requests. Reduce the request rate and try again later.