API reference · FRED

fred/release-tags

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/fred/release-tags
Model IDfred/release-tags
01

Input Schema

11 parameters · 1 required · 10 optional

ParameterTypeRequiredDescription
release_idintegerRequiredThe id for a release. integer, required
limitintegerOptionalThe maximum number of results to return. integer between 1 and 1000, optional, default: 1000 · Min: 1 · Max: 1000 · Default: 1000
offsetintegerOptionalnon-negative integer, optional, default: 0 · Min: 0 · Default: 0
order_bystringOptionalOrder results by values of the specified attribute. One of the following strings: 'series_count', 'popularity', 'created', 'name', 'group_id'. optional, default: series_count · Options: series_count, popularity, created, name, group_id · Default: "series_count"
series_countpopularitycreatednamegroup_id
file_typestringOptionalResponse format. Only json is supported. · Options: json · Default: "json"
json
tag_namesstringOptionalA semicolon delimited list of tag names to only include in the response. See the related request fred/release/related_tags . String, optional, no filtering by tag names by default Example value: 'gnp;quarterly'. This value filters results to only include tags 'gnp' and 'quarterly'.
sort_orderstringOptionalSort results is ascending or descending order for attribute values specified by order_by. One of the following strings: 'asc', 'desc'. optional, default: asc · Options: asc, desc · Default: "asc"
ascdesc
search_textstringOptionalThe words to find matching tags with. String, optional, no filtering by search words by default.
realtime_endstringOptionalThe end of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: today's date
tag_group_idstringOptionalA tag group id to filter tags by type. String, optional, no filtering by tag group by default. One of the following: 'freq', 'gen', 'geo', 'geot', 'rls', 'seas', 'src'. freq = Frequency gen = General or Concept geo = Geography geot = Geography Type rls = Release seas = Seasonal Adjustment src = Sour
realtime_startstringOptionalThe start of the real-time period. For more information, see Real-Time Periods . YYYY-MM-DD formatted string, optional, default: today's date
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description
03

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/fred/release-tags", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 1000,
    "offset": 0,
    "order_by": "series_count",
    "file_type": "json",
    "sort_order": "asc"
  }),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());