How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
String

usestring-ai Sitemap API

Discover the URLs of a whole site as an asynchronous job.

Documentation Provider Profile APIs.io OpenAPI GitHub

usestring-ai Sitemap API is one of 9 APIs that String publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Sitemap. The published artifact set on APIs.io includes an OpenAPI specification and 12 JSON Schemas.

This API exposes 6 operations across 4 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://request.usestring.ai/v1.

6 operations 4 paths 26 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://request.usestring.ai/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

usestring-ai Sitemap API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — A String API key, sent as Authorization: Bearer . Keys are issued in the portal.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Sitemap 6

Discover the URLs of a whole site as an asynchronous job.

POST
/sitemap
Start a site crawl
createSitemapJob body → 202400401403429
GET
/sitemap
List crawl jobs
listSitemapJobs 3 params → 200401429
GET
/sitemap/{jobId}
Read a crawl job
getSitemapJob 2 params → 200401404409429
DELETE
/sitemap/{jobId}
Cancel a crawl job
cancelSitemapJob 2 params → 200401404409429
POST
/sitemap/{jobId}/approve
Approve a quoted crawl
approveSitemapJob 2 params → 200202401402404409429500
GET
/sitemap/{jobId}/urls
Read the URLs a crawl found
getSitemapUrls 4 params → 200401404429

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are SitemapJob (13 properties), SitemapJobSummary (11 properties), ErrorResponse_2 (9 properties), SitemapJob_2 (9 properties). Each schema is shown below with its type and property counts.

SitemapJobQuote
object
5 properties 5 required
ErrorResponse
object
9 properties 2 required
SitemapJobState
SitemapUrl
object
7 properties 6 required
DomainDenied
object
1 property 1 required
SitemapInsufficientFunds
object
4 properties 4 required
SitemapUrlPage
object
3 properties 3 required
SitemapConflict
object
3 properties 3 required
SitemapJobList
object
1 property 1 required
SitemapJob
object
13 properties 8 required
SimpleError
object
1 property 1 required
SitemapJobAck
object
2 properties 2 required
SitemapRequest
object
7 properties 1 required
SitemapCreateRequest
object
Request body for POST /sitemap. Any other field is rejected with a 400.
6 properties 1 required
SitemapJobStatusValue
string
Job status.
SitemapJobAck_2
object
2 properties 2 required
SitemapJobList_2
object
1 property 1 required
SitemapUrlPage_2
object
3 properties 3 required
SitemapJob_2
object
Job status. Extra fields depend on status: awaitingapproval: estimatedCostUsd. running: pending, processed. completed: pagesProcessed, plus urls (full results)…
9 properties 2 required
RateLimitError
429 body. See https://portal.usestring.ai/docs/api-reference/rate-limits
SitemapJobSummary
object
11 properties
SitemapQuote
object
A new job in awaitingapproval. Nothing is crawled or charged until approved. Quotes expire after one hour.
4 properties 4 required
ErrorResponse_2
object
Error body used by most error responses. Errors are always JSON, whatever format the request asked for. Key off statusCode and errorType, not the HTTP status a…
9 properties 1 required
SitemapUrl_2
object
One discovered URL.
8 properties
AccessDeniedResponse
object
403 body when the destination domain is not enabled for your organization. Email support@usestring.ai to request access. See https://portal.usestring.ai/docs/f…
1 property 1 required
SitemapPartialState
object
Approval handoff incomplete. Retry the approve call.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

usestring-ai-sitemap-api-openapi.yml Raw ↑

Other APIs String publishes across the network.

usestring-ai Browser API
AE Profile APIs.io
usestring-ai Builds API
AE Profile APIs.io
usestring-ai Contexts API
AE Profile APIs.io
usestring-ai Documentation API
AE Profile APIs.io
usestring-ai Feeds API
AE Profile APIs.io
usestring-ai Fetch API
AE Profile APIs.io
usestring-ai Search API
AE Profile APIs.io
usestring-ai Sessions API
AE Profile APIs.io
#Sitemap
← Back to U APIs
API Details
ID
usestring-ai:usestring-ai-sitemap-api
Base URL
https://request.usestring.ai/v1
Docs
https://portal.usestring.ai/docs/api-reference/fetch
Provider
String
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=usestring-ai-sitemap-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/usestring-ai-sitemap-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of usestring-ai Sitemap API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.