@everfind/public-api-client
v2026.2.634
Published
TypeScript client SDK for Everfind Public API, generated from OpenAPI.
Downloads
262
Readme
@everfind/public-api-client
TypeScript client SDK for Everfind Public API, generated from OpenAPI.
Install
npm install @everfind/public-api-clientUsage
import { createClient, everfindSearch } from '@everfind/public-api-client';
const client = createClient({
baseUrl: 'https://app.everfind.ai',
headers: {
'x-api-key': process.env.EVERFIND_API_KEY ?? '',
},
});
const response = await everfindSearch({
client,
body: {
query: {
search_string: 'invoice',
},
pagination: {
take: 20,
},
},
});Asset Upsert Endpoints
Public asset ingestion now provides:
POST /backend/public/v1/assets/upsert-with-filePOST /backend/public/v1/assets/upsert-bulk- Optional
Idempotency-Keyrequest header for safe retry semantics.
Upsert With File (multipart form-data)
import {
createClient,
everfindGetTaskStatus,
everfindUpsertAssetWithFile,
} from '@everfind/public-api-client';
const client = createClient({
baseUrl: 'https://app.everfind.ai',
headers: {
'x-api-key': process.env.EVERFIND_API_KEY ?? '',
},
});
const accepted = await everfindUpsertAssetWithFile({
client,
headers: {
'Idempotency-Key': 'doc-1-upsert-v1',
},
body: {
attributes: {
correlation: 'doc-1',
data: {
name: 'Document 1',
assetGroupId: '<asset-group-id>',
iconId: null,
attachments: [],
references: [],
},
},
file: new File(['<binary-content>'], 'document.pdf', {
type: 'application/pdf',
}),
thumbnail: new File(['<binary-content>'], 'thumbnail.png', {
type: 'image/png',
}),
},
});
if (accepted.data?.taskId) {
const status = await everfindGetTaskStatus({
client,
path: { taskId: accepted.data.taskId },
});
console.log(status.data?.status);
}Error Handling
import { createClient, everfindSearch } from '@everfind/public-api-client';
const client = createClient({
baseUrl: 'https://app.everfind.ai',
headers: {
'x-api-key': process.env.EVERFIND_API_KEY ?? '',
},
});
const response = await everfindSearch({
client,
body: { query: { search_string: 'invoice' } },
});
if (response.error) {
console.error('Public API request failed', response.error);
}Notes
- The package exports generated SDK functions and request/response types from
dist/. x-api-keyauthentication is required for protected endpoints.- This package is generated and versioned from Everfind release tags.
