Roark Organization Project API Key API
The Organization Project API Key API from Roark — 2 operation(s) for organization project api key.
The Organization Project API Key API from Roark — 2 operation(s) for organization project api key.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/roark:roark-organization-project-api-key-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Roark Analytics Organization Project API Key API
description: The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform.
version: 1.0.0
servers:
- description: Production
url: https://api.roark.ai
security:
- Bearer: []
tags:
- name: Organization Project API Key
paths:
/v1/org/project/{projectId}/api-key:
get:
responses:
'200':
description: The project API keys
content:
application/json:
schema:
$ref: '#/components/schemas/ListOrgProjectApiKeysResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Authentication error
example:
type: authentication
code: unauthorized
message: Authentication required
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Permission error
example:
type: forbidden
code: permission_denied
message: You do not have permission to access this resource
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found error
example:
type: not_found
code: resource_not_found
message: The requested resource could not be found
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server error
example:
type: internal
code: internal_error
message: Internal server error
description: Internal Server Error
operationId: getV1OrgProjectByProjectIdApi-key
tags:
- Organization Project API Key
summary: List project API keys
description: List API keys for a project (key values are never returned after creation).
parameters:
- schema:
type: string
in: path
name: projectId
required: true
post:
responses:
'200':
description: The created key (value returned once)
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CreateOrgProjectApiKeyResponse'
required:
- data
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Validation error
example:
type: validation
code: invalid_parameter
message: The request was invalid
param: email
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Authentication error
example:
type: authentication
code: unauthorized
message: Authentication required
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Permission error
example:
type: forbidden
code: permission_denied
message: You do not have permission to access this resource
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found error
example:
type: not_found
code: resource_not_found
message: The requested resource could not be found
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server error
example:
type: internal
code: internal_error
message: Internal server error
description: Internal Server Error
operationId: postV1OrgProjectByProjectIdApi-key
tags:
- Organization Project API Key
summary: Generate a project API key
description: 'Mint a new project-scoped API key. The raw key value is returned exactly once in the `key` field: capture it now, it is unreadable afterwards. Defaults to full project access with READ + WRITE scope; narrow with `permissions` / `scopes`.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrgProjectApiKeyInput'
parameters:
- schema:
type: string
in: path
name: projectId
required: true
/v1/org/project/{projectId}/api-key/{keyId}:
delete:
responses:
'200':
description: Revocation result
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/DeleteOrgResourceResponse'
required:
- data
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Authentication error
example:
type: authentication
code: unauthorized
message: Authentication required
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Permission error
example:
type: forbidden
code: permission_denied
message: You do not have permission to access this resource
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Not found error
example:
type: not_found
code: resource_not_found
message: The requested resource could not be found
description: Not Found
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Server error
example:
type: internal
code: internal_error
message: Internal server error
description: Internal Server Error
operationId: deleteV1OrgProjectByProjectIdApi-keyByKeyId
tags:
- Organization Project API Key
summary: Revoke a project API key
description: Revoke (deactivate) a project API key. Idempotent from the caller perspective.
parameters:
- schema:
type: string
in: path
name: projectId
required: true
- schema:
type: string
in: path
name: keyId
required: true
components:
schemas:
OrgProjectApiKey:
type: object
properties:
id:
type: string
name:
type: string
prefix:
type: string
suffix:
type: string
scopes:
type:
- array
- 'null'
items:
type: string
permissions:
type: array
items:
type: string
status:
type:
- string
- 'null'
lastUsedAt:
type:
- string
- 'null'
createdAt:
type: string
updatedAt:
type: string
required:
- id
- name
- prefix
- suffix
- scopes
- permissions
- status
- lastUsedAt
- createdAt
- updatedAt
CreateOrgProjectApiKeyInput:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 255
description: Human label for the key
example: prod-runtime
scopes:
type: array
items:
type: string
enum:
- READ
- WRITE
minItems: 1
permissions:
type: array
items:
type: string
required:
- name
DeleteOrgResourceResponse:
type: object
properties:
id:
type: string
deleted:
type: boolean
const: true
required:
- id
- deleted
ErrorResponse:
type: object
properties:
type:
type: string
enum:
- validation
- authentication
- forbidden
- not_found
- conflict
- payment_required
- rate_limit
- internal
description: The error type category
examples:
- validation
- authentication
code:
type: string
description: Machine-readable error code identifier
examples:
- invalid_parameter
- missing_required_field
- unauthorized
message:
type: string
description: Human-readable error message
examples:
- The request was invalid
- Authentication required
param:
type: string
description: The parameter that caused the error (if applicable)
examples:
- email
- user_id
details:
description: Additional error context information
required:
- type
- code
- message
ListOrgProjectApiKeysResponse:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/OrgProjectApiKey'
required:
- data
CreateOrgProjectApiKeyResponse:
allOf:
- $ref: '#/components/schemas/OrgProjectApiKey'
properties:
key:
type: string
description: The API key value, returned only once at creation
required:
- key
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT