curl --request POST \
  --url https://api.conare.ai/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "gcs",
  "namespace": "reports",
  "bucket": "acme-reports"
}
'

{
  "source": {
    "id": "src_2b9c1f",
    "type": "hubspot",
    "name": "HubSpot",
    "namespace": "docs",
    "status": "connecting",
    "error": "<string>",
    "documents": 123,
    "last_synced_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "sync_interval_s": 123,
    "sync_interval_auto": true,
    "next_sync_at": "2023-11-07T05:31:56Z",
    "cost": {
      "rows_per_run": 123,
      "window_s": 123,
      "reads": "changes",
      "auto_interval_s": 123,
      "usd_per_million_rows": 100,
      "options": [
        {
          "interval_s": 123,
          "auto": true,
          "rows_month": 123,
          "usd_month": 123
        }
      ],
      "rows_billed": true
    },
    "progress": {
      "records_pulled": 123
    }
  },
  "connect_url": "<string>"
}

{
  "id": "src_5d2f0c4e9a1b7c3d8e6f0a12",
  "kind": "custom",
  "type": "<string>",
  "namespace": "docs",
  "user": "<string>",
  "name": "<string>",
  "status": "active",
  "health": "ok",
  "display": {
    "state": "ok",
    "warning": "<string>",
    "action": "<string>"
  },
  "sync": {
    "state": "idle",
    "run_id": "<string>",
    "phase": "<string>",
    "last_success_at": "2023-11-07T05:31:56Z",
    "last_failure_at": "2023-11-07T05:31:56Z",
    "next_run_at": "2023-11-07T05:31:56Z",
    "last_error": {}
  },
  "documents": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "documents_verified_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

المصادر

Connect a source

Connects an app, a custom source or a Google Cloud Storage bucket, synced into one namespace.

An app answers a connect_url where its owner signs in; Twenty, Granola and GitHub take an API key in config instead.
type: custom makes a source you push to (201); with kind: custom and an app’s type, it is listed as that app.
type: gcs (201) needs the bucket granted to GET /sources/gcs’s account and an empty .conare/<organization id> object in it.

POST

https://api.conare.ai

sources

curl --request POST \
  --url https://api.conare.ai/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "gcs",
  "namespace": "reports",
  "bucket": "acme-reports"
}
'

{
  "source": {
    "id": "src_2b9c1f",
    "type": "hubspot",
    "name": "HubSpot",
    "namespace": "docs",
    "status": "connecting",
    "error": "<string>",
    "documents": 123,
    "last_synced_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "sync_interval_s": 123,
    "sync_interval_auto": true,
    "next_sync_at": "2023-11-07T05:31:56Z",
    "cost": {
      "rows_per_run": 123,
      "window_s": 123,
      "reads": "changes",
      "auto_interval_s": 123,
      "usd_per_million_rows": 100,
      "options": [
        {
          "interval_s": 123,
          "auto": true,
          "rows_month": 123,
          "usd_month": 123
        }
      ],
      "rows_billed": true
    },
    "progress": {
      "records_pulled": 123
    }
  },
  "connect_url": "<string>"
}

{
  "id": "src_5d2f0c4e9a1b7c3d8e6f0a12",
  "kind": "custom",
  "type": "<string>",
  "namespace": "docs",
  "user": "<string>",
  "name": "<string>",
  "status": "active",
  "health": "ok",
  "display": {
    "state": "ok",
    "warning": "<string>",
    "action": "<string>"
  },
  "sync": {
    "state": "idle",
    "run_id": "<string>",
    "phase": "<string>",
    "last_success_at": "2023-11-07T05:31:56Z",
    "last_failure_at": "2023-11-07T05:31:56Z",
    "next_run_at": "2023-11-07T05:31:56Z",
    "last_error": {}
  },
  "documents": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "documents_verified_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "text is required",
    "request_id": "7d0f4c1e-2b8a-4e39-9a61-3c5e8b2f9d04"
  }
}

التفويضات

Authorization

string

header

مطلوب

A key from conare.ai/dashboard/keys with full access, some namespaces, or models only (/embed, /rerank, /v1, /v2/rerank, /parse).

الترويسات

Idempotency-Key

string

One key (a UUID) per logical write, sent again on each retry: a repeat within 24 hours replays the first successful answer.

Required string length: 1 - 255

Pattern: ^[\x21-\x7e]+$

الجسم

application/json

Option 1
Option 2
Option 3
Option 4

type

string

مطلوب

A type from GET /sources/types.

namespace

string

مطلوب

1-64 characters of a-z 0-9 _ -, starting with a letter or digit.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$

أمثلة:

"docs"

"user-42"

name

string

Display name; defaults to the app's name.

Maximum string length: 100

redirect_url

string<uri>

sync_interval_s

integer | null

Seconds between syncs; null or absent is the automatic interval.

النطاق المطلوب: 300 <= x <= 2592000

مثال:

3600

config

object

Twenty, Granola and GitHub only; stored encrypted and never returned.

Show child attributes

الاستجابة

The new source and its connect_url (none for Twenty, Granola and GitHub).

source

object

مطلوب

Show child attributes

connect_url

string<uri>

نظرة عامة

مساحات الأسماء

المستندات

البحث

الملفات

التحليل

المصادر

المصادر المخصصة

النماذج

المستخدمون

الأحداث

المؤسسات

الحالة

Connect a source

التفويضات

الترويسات

الجسم

الاستجابة