{ "opencollection": "1.0.0", "info": { "name": "OpenAI Assistants Projects API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Returns a list of projects.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects", "params": [ { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" }, { "name": "include_archived", "value": "", "type": "query", "description": "If `true` returns all projects including those that have been `archived`. Archived projects are not included by default." } ] }, "docs": "Returns a list of projects." }, { "info": { "name": "Create a new project in the organization. Projects can be created and archived, but cannot be deleted.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new project in the organization. Projects can be created and archived, but cannot be deleted." }, { "info": { "name": "Retrieves a project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." } ] }, "docs": "Retrieves a project." }, { "info": { "name": "Modifies a project in the organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects/:project_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a project in the organization." }, { "info": { "name": "Returns a list of API keys in the project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/api_keys", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" } ] }, "docs": "Returns a list of API keys in the project." }, { "info": { "name": "Retrieves an API key in the project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/api_keys/:api_key_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "api_key_id", "value": "", "type": "path", "description": "The ID of the API key." } ] }, "docs": "Retrieves an API key in the project." }, { "info": { "name": "Deletes an API key from the project.\n\nReturns confirmation of the key deletion, or an error if the key belonged to\na service account.\n", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.openai.com/v1/organization/projects/:project_id/api_keys/:api_key_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "api_key_id", "value": "", "type": "path", "description": "The ID of the API key." } ] }, "docs": "Deletes an API key from the project.\n\nReturns confirmation of the key deletion, or an error if the key belonged to\na service account.\n" }, { "info": { "name": "Archives a project in the organization. Archived projects cannot be used or updated.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects/:project_id/archive", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." } ] }, "docs": "Archives a project in the organization. Archived projects cannot be used or updated." }, { "info": { "name": "Returns the rate limits per model for a project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/rate_limits", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. The default is 100.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" }, { "name": "before", "value": "", "type": "query", "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n" } ] }, "docs": "Returns the rate limits per model for a project." }, { "info": { "name": "Updates a project rate limit.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects/:project_id/rate_limits/:rate_limit_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "rate_limit_id", "value": "", "type": "path", "description": "The ID of the rate limit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a project rate limit." }, { "info": { "name": "Returns a list of service accounts in the project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/service_accounts", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" } ] }, "docs": "Returns a list of service accounts in the project." }, { "info": { "name": "Creates a new service account in the project. This also returns an unredacted API key for the service account.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects/:project_id/service_accounts", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new service account in the project. This also returns an unredacted API key for the service account." }, { "info": { "name": "Retrieves a service account in the project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/service_accounts/:service_account_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "service_account_id", "value": "", "type": "path", "description": "The ID of the service account." } ] }, "docs": "Retrieves a service account in the project." }, { "info": { "name": "Deletes a service account from the project.\n\nReturns confirmation of service account deletion, or an error if the project\nis archived (archived projects have no service accounts).\n", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.openai.com/v1/organization/projects/:project_id/service_accounts/:service_account_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "service_account_id", "value": "", "type": "path", "description": "The ID of the service account." } ] }, "docs": "Deletes a service account from the project.\n\nReturns confirmation of service account deletion, or an error if the project\nis archived (archived projects have no service accounts).\n" }, { "info": { "name": "Returns a list of users in the project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/users", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n" }, { "name": "after", "value": "", "type": "query", "description": "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.\n" } ] }, "docs": "Returns a list of users in the project." }, { "info": { "name": "Adds a user to the project. Users must already be members of the organization to be added to a project.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects/:project_id/users", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a user to the project. Users must already be members of the organization to be added to a project." }, { "info": { "name": "Retrieves a user in the project.", "type": "http" }, "http": { "method": "GET", "url": "https://api.openai.com/v1/organization/projects/:project_id/users/:user_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Retrieves a user in the project." }, { "info": { "name": "Modifies a user's role in the project.", "type": "http" }, "http": { "method": "POST", "url": "https://api.openai.com/v1/organization/projects/:project_id/users/:user_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a user's role in the project." }, { "info": { "name": "Deletes a user from the project.\n\nReturns confirmation of project user deletion, or an error if the project is\narchived (archived projects have no users).\n", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.openai.com/v1/organization/projects/:project_id/users/:user_id", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." }, { "name": "user_id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Deletes a user from the project.\n\nReturns confirmation of project user deletion, or an error if the project is\narchived (archived projects have no users).\n" } ] } ], "bundled": true }