Created
May 21, 2023 21:24
-
-
Save selalipop/0f361bfc0651608673658aec50fb5691 to your computer and use it in GitHub Desktop.
Anthropic Claude OpenAPI spec
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.0 | |
info: | |
title: Anthropic LLM API | |
version: 1.0.0 | |
servers: | |
- url: https://api.anthropic.com | |
paths: | |
/v1/complete: | |
post: | |
summary: Sends a prompt to Claude for completion | |
tags: [Complete] | |
requestBody: | |
required: true | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CompleteRequest' | |
responses: | |
"200": | |
description: Successful response | |
content: | |
application/json: | |
schema: | |
$ref: '#/components/schemas/CompleteResponse' | |
components: | |
schemas: | |
CompleteRequest: | |
type: object | |
properties: | |
prompt: | |
type: string | |
description: The prompt you want Claude to complete | |
example: '\n\nHuman: Tell me a haiku about trees\n\nAssistant: ' | |
model: | |
type: string | |
description: Model version to use for completion. Valid options are claude-v1, claude-v1-100k, claude-instant-v1, claude-instant-v1-100k, claude-v1.3, claude-v1.3-100k, claude-v1.2, claude-v1.0, claude-instant-v1.1, claude-instant-v1.1-100k, claude-instant-v1.0. | |
example: claude-v1 | |
enum: | |
- claude-v1 | |
- claude-v1-100k | |
- claude-instant-v1 | |
- claude-instant-v1-100k | |
- claude-v1.3 | |
- claude-v1.3-100k | |
- claude-v1.2 | |
- claude-v1.0 | |
- claude-instant-v1.1 | |
- claude-instant-v1.1-100k | |
- claude-instant-v1.0 | |
max_tokens_to_sample: | |
type: integer | |
description: A maximum number of tokens to generate before stopping | |
example: 300 | |
stop_sequences: | |
type: array | |
items: | |
type: string | |
description: A list of strings upon which to stop generating | |
example: ["\n\nHuman:"] | |
stream: | |
type: boolean | |
description: Whether to incrementally stream the response using SSE | |
example: false | |
temperature: | |
type: number | |
description: Amount of randomness injected into the response. Ranges from 0 to 1. Use temp closer to 0 for analytical / multiple choice, and temp closer to 1 for creative and generative tasks. | |
example: 1 | |
top_k: | |
type: integer | |
description: Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. Set to -1 to disable (default). | |
example: -1 | |
top_p: | |
type: number | |
description: Does nucleus sampling. Compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. Set to -1 to disable (default). Note that you should either alter temperature or top_p, but not both. | |
example: -1 | |
metadata: | |
type: object | |
description: An object describing metadata about the request | |
required: | |
- prompt | |
- model | |
- max_tokens_to_sample | |
CompleteResponse: | |
type: object | |
properties: | |
completion: | |
type: string | |
description: The resulting completion up to and excluding the stop sequences | |
stop_reason: | |
type: string | |
description: The reason we stopped sampling | |
enum: [stop_sequence, max_tokens] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment