Get artifact metadata

GET

artifacts

{id}

Read metadata for an immutable output variant

curl --request GET \
  --url https://revise.io/api/v1/artifacts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://revise.io/api/v1/artifacts/{id}', 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://revise.io/api/v1/artifacts/{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://revise.io/api/v1/artifacts/{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://revise.io/api/v1/artifacts/{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>",
  "format": "docx",
  "filename": "<string>",
  "content_type": "<string>",
  "variant": "tracked_changes",
  "sha256": "<string>",
  "bytes": 123,
  "download_url": "<string>",
  "input_eligible": true,
  "expires_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "prompt_id": "<string>",
  "conversion_id": "<string>",
  "encryption": {
    "format": "jwe",
    "alg": "RSA-OAEP-256",
    "enc": "A256GCM",
    "key_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

See downloads and retention for integration guidance.

TypeScript

import { ReviseClient } from "@reviseio/api";

const revise = new ReviseClient({ apiKey: process.env.REVISE_API_KEY! });
const result = await revise.artifacts.get("art_id");

Authorizations

Authorization

string

header

required

Revise API key from https://revise.io/console/api-keys. Send Authorization: Bearer .

Path Parameters

string

required

Response

Read metadata for an immutable output variant

string

required

format

enum<string>

required

Available options:

docx,

pdf,

md,

html,

txt

filename

string

required

Original plaintext filename, even when encrypted. Encrypted downloads append .jwe.

content_type

string

required

Original plaintext MIME type. Encrypted downloads use application/jose.

variant

enum<string>

required

Available options:

tracked_changes,

clean,

converted

sha256

string

required

SHA-256 of the exact downloadable bytes (ciphertext for encrypted artifacts).

bytes

integer

required

Size of the downloadable bytes, including JWE encoding overhead when encrypted.

download_url

string

required

Account-authenticated API path. The endpoint may redirect to signed storage; never forward bearer credentials to storage.

input_eligible

boolean

required

True only for an unexpired, undeleted, unencrypted prompt artifact. Conversion artifacts are not directly reusable; download and upload them first.

expires_at

string<date-time> | null

required

deleted_at

string<date-time> | null

required

prompt_id

string

conversion_id

string

encryption

object

Show child attributes

Read metadata for an immutable output variant

curl --request GET \
  --url https://revise.io/api/v1/artifacts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://revise.io/api/v1/artifacts/{id}', 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://revise.io/api/v1/artifacts/{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://revise.io/api/v1/artifacts/{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://revise.io/api/v1/artifacts/{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>",
  "format": "docx",
  "filename": "<string>",
  "content_type": "<string>",
  "variant": "tracked_changes",
  "sha256": "<string>",
  "bytes": 123,
  "download_url": "<string>",
  "input_eligible": true,
  "expires_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "prompt_id": "<string>",
  "conversion_id": "<string>",
  "encryption": {
    "format": "jwe",
    "alg": "RSA-OAEP-256",
    "enc": "A256GCM",
    "key_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Getting started

Guides

REST reference

TypeScript

Authorizations

Path Parameters

Response

​TypeScript

Authorizations

Path Parameters

Response

TypeScript