POST
/
completions
from together import Together
import os

client = Together(
api_key=os.environ.get("TOGETHER_API_KEY"),
)

response = client.completions.create(
model="meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo",
prompt="The largest city in France is",
max_tokens=1
)

print(response.choices[0].text)
{
  "id": "<string>",
  "choices": [
    {
      "text": "The capital of France is Paris. It's located in the north-central part of the country and is one of the most populous and visited cities in the world, known for its iconic landmarks like the Eiffel Tower, Louvre Museum, Notre-Dame Cathedral, and more. Paris is also the capital of the Île-de-France region and is a major global center for art, fashion, gastronomy, and culture.",
      "seed": 123,
      "finish_reason": "stop",
      "logprobs": {
        "token_ids": [
          123
        ],
        "tokens": [
          "<string>"
        ],
        "token_logprobs": [
          123
        ]
      }
    }
  ],
  "prompt": [
    {
      "text": "<s>[INST] What is the capital of France? [/INST]",
      "logprobs": {
        "token_ids": [
          123
        ],
        "tokens": [
          "<string>"
        ],
        "token_logprobs": [
          123
        ]
      }
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  },
  "created": 123,
  "model": "<string>",
  "object": "text.completion"
}

Authorizations

Authorization
string
header
default:default
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
prompt
string
required

A string providing context for the model to complete.

Example:

"<s>[INST] What is the capital of France? [/INST]"

model
required

The name of the model to query.<br> <br> See all of Together AI's chat models

Available options:
meta-llama/Llama-2-70b-hf,
mistralai/Mistral-7B-v0.1,
mistralai/Mixtral-8x7B-v0.1,
Meta-Llama/Llama-Guard-7b
Example:

"mistralai/Mixtral-8x7B-Instruct-v0.1"

max_tokens
integer

The maximum number of tokens to generate.

stop
string[]

A list of string sequences that will truncate (stop) inference text output. For example, "</s>" will stop generation as soon as the model generates the given token.

temperature
number

A decimal number from 0-1 that determines the degree of randomness in the response. A temperature less than 1 favors more correctness and is appropriate for question answering or summarization. A value closer to 1 introduces more randomness in the output.

top_p
number

A percentage (also called the nucleus parameter) that's used to dynamically adjust the number of choices for each predicted token based on the cumulative probabilities. It specifies a probability threshold below which all less likely tokens are filtered out. This technique helps maintain diversity and generate more fluent and natural-sounding text.

top_k
integer

An integer that's used to limit the number of choices for the next predicted word or token. It specifies the maximum number of tokens to consider at each step, based on their probability of occurrence. This technique helps to speed up the generation process and can improve the quality of the generated text by focusing on the most likely options.

repetition_penalty
number

A number that controls the diversity of generated text by reducing the likelihood of repeated sequences. Higher values decrease repetition.

stream
boolean

If true, stream tokens as Server-Sent Events as the model generates them instead of waiting for the full model response. The stream terminates with data: [DONE]. If false, return a single JSON object containing the results.

logprobs
integer

An integer between 0 and 20 of the top k tokens to return log probabilities for at each generation step, instead of just the sampled token. Log probabilities help assess model confidence in token predictions.

Required range: 0 <= x <= 20
echo
boolean

If true, the response will contain the prompt. Can be used with logprobs to return prompt logprobs.

n
integer

The number of completions to generate for each prompt.

Required range: 1 <= x <= 128
safety_model

The name of the moderation model used to validate tokens. Choose from the available moderation models found here.

Available options:
Meta-Llama/Llama-Guard-7b
Example:

"safety_model_name"

min_p
number

A number between 0 and 1 that can be used as an alternative to top-p and top-k.

presence_penalty
number

A number between -2.0 and 2.0 where a positive value increases the likelihood of a model talking about new topics.

frequency_penalty
number

A number between -2.0 and 2.0 where a positive value decreases the likelihood of repeating tokens that have already been mentioned.

logit_bias
object

Adjusts the likelihood of specific tokens appearing in the generated output.

Example:
{ "105": 21.4, "1024": -10.5 }
seed
integer

Seed value for reproducibility.

Example:

42

Response

200

id
string
required
choices
object[]
required
usage
object | null
required
created
integer
required
model
string
required
object
enum<string>
required
Available options:
text.completion
prompt
object[]