resources

Create a resource

Creates a resource from a text (type: "text"), one web page ("url") or a whole site ("site", its pages chosen by rules). A site defaults to manual sync on Free and weekly sync on paid plans; recurring intervals require a paid plan. For a file, use POST /v1/resources/file. By default the resource comes back queued and is read and indexed in the background (seconds for a short text, file or page, minutes for a site). Pass ?wait=true to wait up to 15 seconds for it to finish in one call, or poll GET /v1/resources/{id} (?wait=true works there too) until status is ready or failed. Importing costs no credits.

POST/v1/resources

Request

curl --request POST \
  --url 'https://api.lookio.app/v1/resources' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "text",
  "title": "<string>",
  "text": "<string>"
}'

import json
import requests

url = "https://api.lookio.app/v1/resources"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"type\":\"text\",\"title\":\"<string>\",\"text\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.lookio.app/v1/resources", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "type": "text",
    "title": "<string>",
    "text": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/resources");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"type\":\"text\",\"title\":\"<string>\",\"text\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://api.lookio.app/v1/resources", bytes.NewBuffer([]byte("{\"type\":\"text\",\"title\":\"<string>\",\"text\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.lookio.app/v1/resources"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"type\":\"text\",\"title\":\"<string>\",\"text\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.lookio.app/v1/resources")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"type\":\"text\",\"title\":\"<string>\",\"text\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "res_thk6smb5nvts",
    "title": "Refund policy",
    "type": "text",
    "status": "queued",
    "status_detail": null,
    "tags": [
      "legal",
      "faq"
    ],
    "source_url": null,
    "source": "Employee handbook, 2026 edition",
    "site": null,
    "created_at": "2026-10-12T09:30:00.000Z",
    "updated_at": "2026-10-12T09:30:00.000Z"
  },
  "request_id": "req_01K9X7M2Q4"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires resources:write.

Importing is free. The resource comes back queued and is read in the background, in seconds for a page and minutes for a site. Poll Get a resource until status is ready or failed, and stop there.

Text (type: "text"): up to 100,000 characters. Markdown headings become the sections that answers cite.
Web page (type: "url"): one public address. Pages built with JavaScript are read too. See Websites.
Site (type: "site"): a whole site or one section, chosen with rules. Omit schedule to use the plan default: manual on Free, weekly on paid plans. Paid plans also support recurring intervals. Run Preview a site first to see what the rules would import.
File: use Upload a file instead.

An address must be public: localhost, private ranges and non-HTTP schemes are refused. Adding content that would pass the plan’s words-stored limit fails with request_too_large_for_plan. See Word allowance.

Send an Idempotency-Key header so a retried request does not create a second resource.

Authorizations

Authorizationbearerin headerrequired

Query parameters

waitboolean | enum<string>

Wait up to 15 seconds for reading and indexing to finish before returning. Short texts, files and pages usually come back ready (or failed) in one call; larger imports return their current status (queued or processing) when the window ends, never an error.

Header parameters

Idempotency-Keystringlength: 1–255 chars

A unique key for this request, such as a UUID, 1 to 255 visible ASCII characters. Send the same key when you retry: the first response is returned (with Idempotent-Replayed: true) instead of running the request again, for 24 hours, per credential. The same key on a different request is a 409 conflict. A streamed answer is not recorded.

Body

application/jsonrequired

Response

application/json

Add a text, a web page or a site

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^res_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.titlestringrequired

data.typeenum<string>requiredone of: text, file, url, site

data.statusenum<string>requiredone of: queued, processing, ready, failed, stale, ready_simulated

queued and processing: being read and indexed (pass wait=true or poll until it changes). ready: searchable. failed: see status_detail, then fix and call reindex.

data.status_detailstringnullrequired

data.tagsstring[]required

data.source_urlstringnullrequired

The page or site address, for url and site resources.

data.sourcestringnullrequired

Where it comes from, as shown with its citations.

data.siteobject | nullrequired

A site's page rules and schedule; null for other types.

Show child attributes

data.site.rulesobjectrequireddefault: {"include":[],"exclude":[],"excluded_urls":[]}

Show child attributes

data.site.rules.includestring[]requireddefault: []items: ≤ 50 items

Path patterns to keep, such as /docs/**. * is one level, ** everything below. Empty keeps the whole site.

data.site.rules.excludestring[]requireddefault: []items: ≤ 50 items

Path patterns to leave out, such as /blog/**.

data.site.rules.regexstringlength: ≤ 500 chars

Advanced: a regular expression on the path; matching pages are left out.

data.site.rules.excluded_urlsstring[]requireddefault: []items: ≤ 5000 items

Single pages to leave out, by full address.

manual syncs only on request. Recurring schedules accept daily, weekly, monthly, or every_N_days, every_N_weeks and every_N_months (1-90 days, 1-52 weeks, 1-12 months). Recurring schedules require a paid plan.

data.site.last_synced_atstringnullrequired

data.created_atstringrequired

data.updated_atstringrequired

request_idstringrequired

Create a resource

Authorizations

Query parameters

Header parameters

Body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown