Create embedding

curl --request POST \
  --url https://api.together.xyz/v1/embeddings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "togethercomputer/m2-bert-80M-8k-retrieval",
  "input": "Our solar system orbits the Milky Way galaxy at about 515,000 mph"
}
'

import requests

url = "https://api.together.xyz/v1/embeddings"

payload = {
    "model": "togethercomputer/m2-bert-80M-8k-retrieval",
    "input": "Our solar system orbits the Milky Way galaxy at about 515,000 mph"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'togethercomputer/m2-bert-80M-8k-retrieval',
    input: 'Our solar system orbits the Milky Way galaxy at about 515,000 mph'
  })
};

fetch('https://api.together.xyz/v1/embeddings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.xyz/v1/embeddings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'togethercomputer/m2-bert-80M-8k-retrieval',
    'input' => 'Our solar system orbits the Milky Way galaxy at about 515,000 mph'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.together.xyz/v1/embeddings"

	payload := strings.NewReader("{\n  \"model\": \"togethercomputer/m2-bert-80M-8k-retrieval\",\n  \"input\": \"Our solar system orbits the Milky Way galaxy at about 515,000 mph\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.together.xyz/v1/embeddings")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"togethercomputer/m2-bert-80M-8k-retrieval\",\n  \"input\": \"Our solar system orbits the Milky Way galaxy at about 515,000 mph\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.together.xyz/v1/embeddings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"togethercomputer/m2-bert-80M-8k-retrieval\",\n  \"input\": \"Our solar system orbits the Milky Way galaxy at about 515,000 mph\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "model": "<string>",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        123
      ],
      "index": 123
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

POST

embeddings

Create embedding

curl --request POST \
  --url https://api.together.xyz/v1/embeddings \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "togethercomputer/m2-bert-80M-8k-retrieval",
  "input": "Our solar system orbits the Milky Way galaxy at about 515,000 mph"
}
'

import requests

url = "https://api.together.xyz/v1/embeddings"

payload = {
    "model": "togethercomputer/m2-bert-80M-8k-retrieval",
    "input": "Our solar system orbits the Milky Way galaxy at about 515,000 mph"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'togethercomputer/m2-bert-80M-8k-retrieval',
    input: 'Our solar system orbits the Milky Way galaxy at about 515,000 mph'
  })
};

fetch('https://api.together.xyz/v1/embeddings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.xyz/v1/embeddings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'togethercomputer/m2-bert-80M-8k-retrieval',
    'input' => 'Our solar system orbits the Milky Way galaxy at about 515,000 mph'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.together.xyz/v1/embeddings"

	payload := strings.NewReader("{\n  \"model\": \"togethercomputer/m2-bert-80M-8k-retrieval\",\n  \"input\": \"Our solar system orbits the Milky Way galaxy at about 515,000 mph\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.together.xyz/v1/embeddings")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"togethercomputer/m2-bert-80M-8k-retrieval\",\n  \"input\": \"Our solar system orbits the Milky Way galaxy at about 515,000 mph\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.together.xyz/v1/embeddings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"togethercomputer/m2-bert-80M-8k-retrieval\",\n  \"input\": \"Our solar system orbits the Milky Way galaxy at about 515,000 mph\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "model": "<string>",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        123
      ],
      "index": 123
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

Authorizations

Authorization

string

header

default:default

required

Body

application/json

model

string

required

The name of the embedding model to use.

Example:

"togethercomputer/m2-bert-80M-8k-retrieval"

input

string

required

A string providing the text for the model to embed.

Example:

"Our solar system orbits the Milky Way galaxy at about 515,000 mph"

Response

200

object

enum<string>

required

Available options:

list

model

string

required

data

object[]

required

Show child attributes

Chat

Completion

Embeddings

Models

Images

Files

Fine-tuning

Create embedding

Authorizations

Body

Response