provider 47 operations 15 docs pages
@utdk/figma
Figma API
Generated UTDK provider client for Figma API. This is the OpenAPI specification for the Figma REST API.
Note: we are releasing the OpenAPI specification as a beta given the large surface area and complexity of the REST API. If you notice any inaccuracies with the specification, please file an issue.
OEmbed
Optional generated docs page for
@utdk/figma.
OEmbed
Use these operations through the generated client (not direct HTTP calls).
Import path: @utdk/figma
Operations
figma.getOEmbed
- HTTP:
GET /v1/oembed - What it does: Get oEmbed data
- OpenAPI operationId:
getOEmbed - Path params: None
- Query params:
url,maxwidth,maxheight - Response codes:
200,400,404,429,501 - Transport options: None
- Source: OpenAPI reference
- TypeScript: Client interface
Inputs
- Client input type:
{ url: string; maxwidth?: number; maxheight?: number } - Client transport options: None
Outputs
- Client return type:
{ version: string; type: string; title: string; key?: string; url: string; provider_name: string; provider_url: string; cache_age: number; width: number; height: number; html: string; is_published_site?: boolean; folder... - OpenAPI response codes:
200,400,404,429,501
import figma from "@utdk/figma";
type GetOEmbedInput = Parameters<typeof figma.getOEmbed> extends [infer T, ...unknown[]] ? T : undefined;
type GetOEmbedOutput = Awaited<ReturnType<typeof figma.getOEmbed>>;
const input: GetOEmbedInput = {} as { url: string; maxwidth?: number; maxheight?: number };
const result: GetOEmbedOutput = await figma.getOEmbed(input);
// Result shape (from schema): { version: string; type: string; title: string; key?: string; url: string; provider_name: string; provider_url: string; cache_age: number; width: number; height: number; html: string; is_published_site?: boolean; folder...