How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OpenAI

OpenAI Roles API

The Roles API from OpenAI — 4 operation(s) for roles.

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenAI Roles API is one of 62 APIs that OpenAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 10 operations across 4 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2.3.0.

Requests are made against a single base URL, https://api.openai.com/v1.

10 operations 4 paths 10 schemas 2 DELETE4 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.3.0
Base URL
https://api.openai.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
OpenAI Support
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

OpenAI Roles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). It accepts HTTP bearer tokens (AdminApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Roles 10
GET
/organization/roles
List organization roles
list-roles 3 params → 200429
POST
/organization/roles
Create organization role
create-role body → 200429
GET
/organization/roles/{role_id}
Retrieve organization role
retrieve-role 1 param → 200429
POST
/organization/roles/{role_id}
Update organization role
update-role 1 param body → 200429
DELETE
/organization/roles/{role_id}
Delete organization role
delete-role 1 param → 200429
GET
/projects/{project_id}/roles
List project roles
list-project-roles 4 params → 200429
POST
/projects/{project_id}/roles
Create project role
create-project-role 1 param body → 200429
GET
/projects/{project_id}/roles/{role_id}
Retrieve project role
retrieve-project-role 2 params → 200429
POST
/projects/{project_id}/roles/{role_id}
Update project role
update-project-role 2 params body → 200429
DELETE
/projects/{project_id}/roles/{role_id}
Delete project role
delete-project-role 2 params → 200429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Role (7 properties), Error (5 properties), PublicRoleListResource (4 properties), MisalignmentErrorDetailsResource (3 properties). Each schema is shown below with its type and property counts.

_MisalignmentErrorType
Role
object
Details about a role that can be assigned through the public Roles API.
7 properties 7 required
RoleDeletedResource
object
Confirmation payload returned after deleting a role.
3 properties 3 required
PublicUpdateOrganizationRoleBody
object
Request payload for updating an existing role.
3 properties
_MisalignmentSteer
object
1 property 1 required
PublicRoleListResource
object
Paginated list of roles available on an organization or project.
4 properties 4 required
ErrorResponse
object
1 property 1 required
Error
object
5 properties 4 required
MisalignmentErrorDetailsResource
object
3 properties
PublicCreateOrganizationRoleBody
object
Request payload for creating a custom role.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openai-roles-api-openapi.yml Raw ↑

Other APIs OpenAI publishes across the network.

OpenAI Responses API
AE Profile APIs.io
OpenAI Moderations API
AE Profile APIs.io
OpenAI Batch API
AE Profile APIs.io
OpenAI Vector Stores API
AE Profile APIs.io
OpenAI Uploads API
AE Profile APIs.io
OpenAI Realtime API
AE Profile APIs.io
OpenAI Evals API
AE Profile APIs.io
OpenAI Videos API
AE Profile APIs.io
OpenAI Conversations API
AE Profile APIs.io
OpenAI Containers API
AE Profile APIs.io
OpenAI ChatKit API
AE Profile APIs.io
OpenAI Skills API
AE Profile APIs.io
#Roles
← Back to O APIs
API Details
ID
openai:openai-roles-api
Base URL
https://api.openai.com
Docs
https://platform.openai.com/docs/assistants/overview
Provider
OpenAI
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openai-roles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openai-roles-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenAI Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.