Completions

Generate text based on the given text prompt.

post/v1/completions

Request

Base URL
http://localhost:8000
Auth
none declared
TypeScript
https://skmtc.dev/friendli/apis/friendli-suite-api-reference/docs/v1/completions/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "model": "(adapter-route)",
  "max_tokens": 200,
  "top_k": 1
}

Response

Successfully generated completions.

idstring required

A unique ID of the completion.

object'text_completion' required

The object type, which is always set to text_completion.

modelstring nullable

The model to generate the completion. For dedicated endpoints, it returns the endpoint id.

Example response

{
  "usage": {
    "prompt_tokens": 5,
    "completion_tokens": 7,
    "total_tokens": 12
  },
  "choices": [
    {
      "text": "This is indeed a test",
      "seed": 42,
      "tokens": [
        128000,
        2028,
        374,
        13118,
        264,
        1296
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.