Skip to main content

EstuaryClient.ContentApi

All URIs are relative to //api.estuary.tech/

MethodHTTP requestDescription
adminInvitesGetGET /admin/invitesGet Estuary invites
adminInvitesPostPOST /admin/invitesCreate an Estuary invite
contentAddCarPostPOST /content/add-carAdd Car object
contentAddIpfsPostPOST /content/add-ipfsAdd IPFS object
contentAddPostPOST /content/addAdd new content
contentAggregatedContentGetGET /content/aggregated/{content}Get aggregated content stats
contentAllDealsGetGET /content/all-dealsGet all deals for a user
contentBwUsageContentGetGET /content/bw-usage/{content}Get content bandwidth
contentCreatePostPOST /content/createAdd a new content
contentDealsGetGET /content/dealsContent with deals
contentEnsureReplicationDatacidGetGET /content/ensure-replication/{datacid}Ensure Replication
contentFailuresContentGetGET /content/failures/{content}List all failures for a content
contentIdGetGET /content/{id}Content
contentImportdealPostPOST /content/importdealImport a deal
contentListGetGET /content/listList all pinned content
contentReadContGetGET /content/read/{cont}Read content
contentStagingZonesGetGET /content/staging-zonesGet staging zone for user
contentStatsGetGET /content/statsGet content statistics
contentStatusIdGetGET /content/status/{id}Content Status

adminInvitesGet

'String' adminInvitesGet()

Get Estuary invites

This endpoint is used to list all estuary invites.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
apiInstance.adminInvitesGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

adminInvitesPost

'String' adminInvitesPost(code)

Create an Estuary invite

This endpoint is used to create an estuary invite.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let code = "code_example"; // String | Invite code to be created

apiInstance.adminInvitesPost(code, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
codeStringInvite code to be created

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentAddCarPost

UtilContentAddResponse contentAddCarPost(body, opts)

Add Car object

This endpoint is used to add a car object to the network. The object can be a file or a directory.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let body = "body_example"; // String | Car
let opts = {
'ignoreDupes': "ignoreDupes_example", // String | Ignore Dupes
'filename': "filename_example" // String | Filename
};
apiInstance.contentAddCarPost(body, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
bodyStringCar
ignoreDupesStringIgnore Dupes[optional]
filenameStringFilename[optional]

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

contentAddIpfsPost

'String' contentAddIpfsPost(body, opts)

Add IPFS object

This endpoint is used to add an IPFS object to the network. The object can be a file or a directory.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let body = new EstuaryClient.UtilContentAddIpfsBody(); // UtilContentAddIpfsBody | IPFS Body
let opts = {
'ignoreDupes': "ignoreDupes_example" // String | Ignore Dupes
};
apiInstance.contentAddIpfsPost(body, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
bodyUtilContentAddIpfsBodyIPFS Body
ignoreDupesStringIgnore Dupes[optional]

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

contentAddPost

UtilContentAddResponse contentAddPost(data, filename, opts)

Add new content

This endpoint is used to upload new content.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let data = "data_example"; // Blob |
let filename = "filename_example"; // String |
let opts = {
'coluuid': "coluuid_example", // String | Collection UUID
'replication': 56, // Number | Replication value
'ignoreDupes': "ignoreDupes_example", // String | Ignore Dupes true/false
'lazyProvide': "lazyProvide_example", // String | Lazy Provide true/false
'dir': "dir_example" // String | Directory
};
apiInstance.contentAddPost(data, filename, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
dataBlob
filenameString
coluuidStringCollection UUID[optional]
replicationNumberReplication value[optional]
ignoreDupesStringIgnore Dupes true/false[optional]
lazyProvideStringLazy Provide true/false[optional]
dirStringDirectory[optional]

Return type

UtilContentAddResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

contentAggregatedContentGet

'String' contentAggregatedContentGet(content)

Get aggregated content stats

This endpoint returns aggregated content stats

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let content = "content_example"; // String | Content ID

apiInstance.contentAggregatedContentGet(content, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
contentStringContent ID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentAllDealsGet

'String' contentAllDealsGet(begin, duration, all)

Get all deals for a user

This endpoint is used to get all deals for a user

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let begin = "begin_example"; // String | Begin
let duration = "duration_example"; // String | Duration
let all = "all_example"; // String | All

apiInstance.contentAllDealsGet(begin, duration, all, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
beginStringBegin
durationStringDuration
allStringAll

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentBwUsageContentGet

'String' contentBwUsageContentGet(content)

Get content bandwidth

This endpoint returns content bandwidth

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let content = "content_example"; // String | Content ID

apiInstance.contentBwUsageContentGet(content, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
contentStringContent ID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentCreatePost

'String' contentCreatePost(body, opts)

Add a new content

This endpoint adds a new content

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let body = new EstuaryClient.UtilContentCreateBody(); // UtilContentCreateBody | Content
let opts = {
'ignoreDupes': "ignoreDupes_example" // String | Ignore Dupes
};
apiInstance.contentCreatePost(body, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
bodyUtilContentCreateBodyContent
ignoreDupesStringIgnore Dupes[optional]

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

contentDealsGet

'String' contentDealsGet(opts)

Content with deals

This endpoint lists all content with deals

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let opts = {
'limit': 56, // Number | Limit
'offset': 56 // Number | Offset
};
apiInstance.contentDealsGet(opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
limitNumberLimit[optional]
offsetNumberOffset[optional]

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentEnsureReplicationDatacidGet

'String' contentEnsureReplicationDatacidGet(datacid)

Ensure Replication

This endpoint ensures that the content is replicated to the specified number of providers

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let datacid = "datacid_example"; // String | Data CID

apiInstance.contentEnsureReplicationDatacidGet(datacid, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
datacidStringData CID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentFailuresContentGet

'String' contentFailuresContentGet(content)

List all failures for a content

This endpoint returns all failures for a content

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let content = "content_example"; // String | Content ID

apiInstance.contentFailuresContentGet(content, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
contentStringContent ID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentIdGet

'String' contentIdGet(id)

Content

This endpoint returns a content by its ID

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let id = 56; // Number | Content ID

apiInstance.contentIdGet(id, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
idNumberContent ID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentImportdealPost

'String' contentImportdealPost(body)

Import a deal

This endpoint imports a deal into the shuttle.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let body = new EstuaryClient.MainImportDealBody(); // MainImportDealBody | Import a deal

apiInstance.contentImportdealPost(body, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
bodyMainImportDealBodyImport a deal

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: /
  • Accept: application/json

contentListGet

'String' contentListGet()

List all pinned content

This endpoint lists all content

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
apiInstance.contentListGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentReadContGet

'String' contentReadContGet(cont)

Read content

This endpoint reads content from the blockstore

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let cont = "cont_example"; // String | CID

apiInstance.contentReadContGet(cont, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
contStringCID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentStagingZonesGet

'String' contentStagingZonesGet()

Get staging zone for user

This endpoint is used to get staging zone for user.

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
apiInstance.contentStagingZonesGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentStatsGet

'String' contentStatsGet(limit, offset)

Get content statistics

This endpoint is used to get content statistics. Every content stored in the network (estuary) is tracked by a unique ID which can be used to get information about the content. This endpoint will allow the consumer to get the collected stats of a conten

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let limit = "limit_example"; // String | limit
let offset = "offset_example"; // String | offset

apiInstance.contentStatsGet(limit, offset, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
limitStringlimit
offsetStringoffset

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

contentStatusIdGet

'String' contentStatusIdGet(id)

Content Status

This endpoint returns the status of a content

Example

import {EstuaryClient} from 'estuary-client';
let defaultClient = EstuaryClient.ApiClient.instance;

// Configure API key authorization: bearerAuth
let bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix = 'Token';

let apiInstance = new EstuaryClient.ContentApi();
let id = 56; // Number | Content ID

apiInstance.contentStatusIdGet(id, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});

Parameters

NameTypeDescriptionNotes
idNumberContent ID

Return type

'String'

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json