GET /api/v1/sites/{slug}

GET/api/v1/sites/{slug}

Authorization

AuthorizationBearer token (Zawqi Agent Token) · headerrequired

Zawqi Agent Token. Send it as a Bearer token in the Authorization header.

Path parameters

slugstringrequired

Responses

200Success

idstringrequired

slugstringrequired

urlstringrequired

siteNamestringrequired

industrystring | anyrequired

Show properties

Any of:

string

string

any

any

publishedbooleanrequired

fullPageScreenshotUrlstring | anyrequired

Show properties

Any of:

string

string

any

any

renderedHtmlUrlstring | anyrequired

Show properties

Any of:

string

string

any

any

homepageMarkdownUrlstring | anyrequired

Show properties

Any of:

string

string

any

any

logoUrlstring | anyrequired

Show properties

Any of:

string

string

any

any

logoMetadataanyrequired

Show properties

Any of:

any

any

any

any

openGraphUrlstring | anyrequired

Show properties

Any of:

string

string

any

any

openGraphMetadataanyrequired

Show properties

Any of:

any

any

any

any

pricingMarkdownUrlstring | anyrequired

Show properties

Any of:

string

string

any

any

backersobject[]required

Show properties

Array of object

namestringrequired

websitestringrequired

relationshipstringrequired

Allowed:backed-byaccelerated-by

createdAtstringrequired

updatedAtstringrequired

401Unauthorized

_tagstringrequired

Allowed:Unauthorized

402LifetimeAccessRequired

_tagstringrequired

Allowed:LifetimeAccessRequired

messagestringrequired

404NotFound

_tagstringrequired

Allowed:NotFound

429FreeResearchWeeklyLimitReached

_tagstringrequired

Allowed:FreeResearchWeeklyLimitReached

messagestringrequired

callsLimitnumber | stringrequired

Show properties

Any of:

number

number

string

string

resetsAtstringrequired

Request

curl -X GET "https://pr-223.zawqi.app/api/v1/sites/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://pr-223.zawqi.app/api/v1/sites/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "id": "string",
  "slug": "string",
  "url": "string",
  "siteName": "string",
  "industry": "ai-ml",
  "published": true,
  "fullPageScreenshotUrl": "string",
  "renderedHtmlUrl": "string",
  "homepageMarkdownUrl": "string",
  "logoUrl": "string",
  "logoMetadata": "string",
  "openGraphUrl": "string",
  "openGraphMetadata": "string",
  "pricingMarkdownUrl": "string",
  "backers": [
    {
      "name": "string",
      "website": "string",
      "relationship": "backed-by"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string"
}