> ## Documentation Index > Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create prompts prompts > Requires scopes: eval:write ## OpenAPI ````yaml /api-reference/openapi.json post /api/prompts openapi: 3.1.2 info: title: EvalGate API version: 18.13.0 description: EvalGate API. See docs/api-contract.md for stability commitments. servers: - url: https://evalgate.com description: Production - url: http://localhost:3000 description: Local security: [] paths: /api/prompts: post: tags: - prompts summary: Create prompts prompts description: 'Requires scopes: eval:write' operationId: post_prompts requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PostApiPromptsRequest' responses: '201': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PostApiPromptsResponse201ApplicationJson' '400': $ref: '#/components/responses/ValidationError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' security: - bearerAuth: [] components: schemas: PostApiPromptsRequest: type: object properties: name: type: string definition: type: object properties: model: type: object properties: provider: type: string model: type: string routingKey: type: string additionalProperties: false inputSchema: type: object additionalProperties: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' messages: type: array items: type: object properties: id: type: string role: oneOf: - type: string enum: - user - type: string enum: - tool - type: string enum: - system - type: string enum: - developer - type: string enum: - example - type: string enum: - assistant content: type: string name: type: string toolCallId: type: string additionalProperties: false required: - id - role - content tags: type: array items: type: string tools: type: array items: type: object properties: name: type: string inputSchema: type: object additionalProperties: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' strict: oneOf: - type: boolean enum: - false - type: boolean enum: - true description: type: string additionalProperties: false required: - name - inputSchema outputSchema: type: object additionalProperties: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' parameters: type: object properties: temperature: type: number maxTokens: type: number seed: type: number max_tokens: type: number additionalProperties: false dataPolicy: type: string variables: type: array items: type: object properties: type: oneOf: - type: string enum: - string - type: string enum: - number - type: string enum: - boolean - type: string enum: - object - type: string enum: - integer - type: string enum: - array name: type: string required: type: boolean default: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - $ref: '#/components/schemas/JsonValue' description: type: string additionalProperties: false required: - type - name - required responseFormat: oneOf: - type: string enum: - json - type: string enum: - text - type: string enum: - json_schema fallbackPolicy: type: string additionalProperties: false required: - model - inputSchema - messages key: type: string description: type: string idempotencyKey: type: string additionalProperties: false required: - name - definition - key PostApiPromptsResponse201ApplicationJson: type: object properties: artifactId: type: number key: type: string name: type: string version: type: object properties: createdAt: type: string submittedAt: oneOf: - type: 'null' - type: string approvedAt: oneOf: - type: 'null' - type: string definition: type: object properties: messages: type: array items: type: object properties: id: type: string role: oneOf: - type: string enum: - user - type: string enum: - tool - type: string enum: - system - type: string enum: - developer - type: string enum: - example - type: string enum: - assistant content: type: string name: type: string toolCallId: type: string additionalProperties: false required: - id - role - content variables: type: array items: type: object properties: name: type: string type: oneOf: - type: string enum: - string - type: string enum: - number - type: string enum: - boolean - type: string enum: - object - type: string enum: - integer - type: string enum: - array required: type: boolean description: type: string default: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - $ref: '#/components/schemas/JsonValue' additionalProperties: false required: - name - type - required inputSchema: type: object properties: type: oneOf: - type: string - type: array items: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' required: type: array items: type: string additionalProperties: oneOf: - type: boolean enum: - false - type: boolean enum: - true - $ref: '#/components/schemas/JsonValue' items: $ref: '#/components/schemas/JsonValue' enum: type: array items: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false outputSchema: type: object properties: type: oneOf: - type: string - type: array items: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' required: type: array items: type: string additionalProperties: oneOf: - type: boolean enum: - false - type: boolean enum: - true - $ref: '#/components/schemas/JsonValue' items: $ref: '#/components/schemas/JsonValue' enum: type: array items: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false model: type: object properties: provider: type: string model: type: string routingKey: type: string additionalProperties: false parameters: type: object additionalProperties: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' tools: type: array items: type: object properties: name: type: string description: type: string inputSchema: type: object properties: type: oneOf: - type: string - type: array items: type: string properties: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' required: type: array items: type: string additionalProperties: oneOf: - type: boolean enum: - false - type: boolean enum: - true - $ref: '#/components/schemas/JsonValue' items: $ref: '#/components/schemas/JsonValue' enum: type: array items: oneOf: - type: 'null' - type: string - type: number - type: boolean enum: - false - type: boolean enum: - true - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false strict: oneOf: - type: boolean enum: - false - type: boolean enum: - true additionalProperties: false required: - name - inputSchema responseFormat: oneOf: - type: string enum: - json - type: string enum: - text - type: string enum: - json_schema dataPolicy: type: string fallbackPolicy: type: string tags: type: array items: type: string additionalProperties: false required: - messages - variables - inputSchema - model - parameters - tools - tags versionId: type: number artifactId: type: number organizationId: $ref: '#/components/schemas/OrganizationId' versionNumber: type: number payload: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' summary: type: object additionalProperties: $ref: '#/components/schemas/JsonValue' metadata: oneOf: - type: 'null' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' createdBy: type: string parentVersionId: oneOf: - type: 'null' - type: number contentHash: type: string reviewStatus: type: string reviewRevision: type: number submittedBy: oneOf: - type: 'null' - type: string approvedBy: oneOf: - type: 'null' - type: string additionalProperties: false required: - createdAt - submittedAt - approvedAt - definition - versionId - artifactId - organizationId - versionNumber - payload - summary - metadata - createdBy - parentVersionId - contentHash - reviewStatus - reviewRevision - submittedBy - approvedBy additionalProperties: false required: - artifactId - key - name - version JsonValue: oneOf: - type: 'null' - type: boolean - type: number - type: string - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' OrganizationId: type: string format: uuid ApiError: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - INVALID_REFERENCE - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_ERROR - SERVICE_UNAVAILABLE - QUOTA_EXCEEDED - FEATURE_LIMIT_REACHED - NO_ORG_MEMBERSHIP - SHARE_REVOKED - SHARE_EXPIRED - SHARE_UNAVAILABLE - PROVIDER_KEY_MISSING - PROVIDER_KEY_EXPIRED - PROVIDER_RATE_LIMITED - PROVIDER_UNAUTHORIZED - PROVIDER_UNAVAILABLE - AGENT_HANDOFF_INVALID - AGENT_HANDOFF_EXPIRED - AGENT_HANDOFF_DENIED - AGENT_HANDOFF_CONSUMED - PAYLOAD_TOO_LARGE - METHOD_NOT_ALLOWED message: type: string details: {} requestId: type: string format: uuid redaction: type: object properties: applied: type: boolean enum: - true fieldCount: type: integer minimum: 0 secretCount: type: integer minimum: 0 required: - applied - fieldCount - secretCount required: - code - message required: - error responses: ValidationError: description: Validation error content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string WWW-Authenticate: description: >- Bearer challenge. Agent-facing routes include the RFC 9728 resource_metadata URL. schema: type: string Forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Conflict: description: Conflict content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string RateLimited: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string Retry-After: description: Delay in seconds before retrying when present. schema: type: integer minimum: 1 InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string ServiceUnavailable: description: Service unavailable content: application/json: schema: $ref: '#/components/schemas/ApiError' headers: RateLimit-Limit: description: Quota in requests for the active window. schema: type: integer minimum: 0 RateLimit-Remaining: description: Remaining requests in the active window. schema: type: integer minimum: 0 RateLimit-Reset: description: Reset delay in seconds (not a Unix timestamp). schema: type: integer minimum: 1 X-RateLimit-Limit: schema: type: integer minimum: 0 X-RateLimit-Remaining: schema: type: integer minimum: 0 X-RateLimit-Reset: description: Legacy reset timestamp in Unix milliseconds. schema: type: integer minimum: 0 RateLimit-Policy: description: IETF HTTPAPI structured quota policy (work in progress). schema: type: string RateLimit: description: >- IETF HTTPAPI structured remaining quota and reset delay (work in progress). schema: type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: EvalGate API key description: >- Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes. x-evalgate-scopes-supported: - eval:read - eval:write - objectives:read - objectives:write - runs:read - runs:write - traces:read - traces:write - exports:download - reports:write - prompt:publish - scorer:publish - red_team:read - red_team:run - red_team:approve - docs:read - agent:read - agent:execute - resources:read - resources:write - contexts:read - contexts:write - observations:write - checks:read - checks:run - standards:read - standards:write - standards:approve - grants:read - grants:write - admin:keys - admin:workspace - admin:org x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.