Get a remote model upload

GET

projects

{projectId}

models

uploads

{id}

Together AI SDK (Python)

from together import Together

client = Together()
identity = client.whoami()
if identity.type != "project_api_key":
    raise RuntimeError("TOGETHER_API_KEY must be a project API key")
project_id = identity.project.id

job = client.models.remote_uploads.retrieve(
    "job_abc123",
    project_id=project_id,
)
print(job)

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

const job = await client.models.remoteUploads.retrieve("job_abc123", {
  projectId,
});
console.log(job);

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

const job = await client.models.remoteUploads.retrieve("job_abc123", {
  projectId,
});
console.log(job);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/projects/{projectId}/models/uploads/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.together.ai/v2/projects/{projectId}/models/uploads/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.together.ai/v2/projects/{projectId}/models/uploads/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "projectId": "<string>",
  "modelId": "<string>",
  "remoteUrl": "<string>",
  "status": "REMOTE_UPLOAD_STATUS_PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "statusMessage": "<string>",
  "restartCount": 123,
  "maxRestarts": 123,
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

Authorizations

Authorization

string

header

default:default

required

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

Path Parameters

projectId

string

required

Project identifier.

string

required

Remote upload identifier.

Response

Asynchronous job that imports remote files into a registered model and creates a model revision.

string

required

Unique ID of the remote model import job.

projectId

string

required

ID of the project that owns the import job.

modelId

string

required

ID of the registered model receiving the imported files.

remoteUrl

string

required

Hugging Face repository or presigned URL being imported.

status

enum<string>

required

Current lifecycle state of the asynchronous import job.

Available options:

REMOTE_UPLOAD_STATUS_PENDING,

REMOTE_UPLOAD_STATUS_RUNNING,

REMOTE_UPLOAD_STATUS_ERROR,

REMOTE_UPLOAD_STATUS_SUCCEEDED,

REMOTE_UPLOAD_STATUS_FAILED

createdAt

string<date-time>

required

Time when the import job was created.

statusMessage

string

Human-readable progress or failure detail for the current status.

restartCount

integer

Number of times the import worker has restarted this job.

maxRestarts

integer

Maximum worker restarts allowed before the job fails permanently.

updatedAt

string<date-time>

Time when the import job was last updated.

⌘I

Together AI SDK (Python)

from together import Together

client = Together()
identity = client.whoami()
if identity.type != "project_api_key":
    raise RuntimeError("TOGETHER_API_KEY must be a project API key")
project_id = identity.project.id

job = client.models.remote_uploads.retrieve(
    "job_abc123",
    project_id=project_id,
)
print(job)

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

const job = await client.models.remoteUploads.retrieve("job_abc123", {
  projectId,
});
console.log(job);

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

const job = await client.models.remoteUploads.retrieve("job_abc123", {
  projectId,
});
console.log(job);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/projects/{projectId}/models/uploads/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.together.ai/v2/projects/{projectId}/models/uploads/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.together.ai/v2/projects/{projectId}/models/uploads/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "projectId": "<string>",
  "modelId": "<string>",
  "remoteUrl": "<string>",
  "status": "REMOTE_UPLOAD_STATUS_PENDING",
  "createdAt": "2023-11-07T05:31:56Z",
  "statusMessage": "<string>",
  "restartCount": 123,
  "maxRestarts": 123,
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

TOGETHER APIS

SDK LIBRARIES

ERROR CODES

Authorizations

Path Parameters

Response