Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions docs/references/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
id: api-reference
title: API reference
sidebar_label: API reference
description: Includes links to all Temporal SDK API references for Go, Java, Python, TypeScript, .NET, PHP, and Ruby.
keywords:
- api reference
- sdk api
- go api
- java api
- python api
- typescript api
- dotnet api
- php api
- ruby api
tags:
- Reference
- SDK
---

# API reference

Complete API documentation for all Temporal SDKs and server APIs.

## SDK API References

<div className="pattern-grid">
<a href="https://pkg.go.dev/go.temporal.io/sdk" className="pattern-card" target="_blank" rel="noopener noreferrer">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could these elements be made into components and reused instead of the duplicate code?

<div className="pattern-content">
<h3>Go SDK API</h3>
<p>Complete Go SDK API documentation on pkg.go.dev with all packages, types, and methods.</p>
</div>
</a>

<a href="https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html" className="pattern-card" target="_blank" rel="noopener noreferrer">
<div className="pattern-content">
<h3>Java SDK API</h3>
<p>Complete Java SDK API documentation on javadoc.io with all classes, interfaces, and annotations.</p>
</div>
</a>

<a href="https://php.temporal.io/namespaces/temporal.html" className="pattern-card" target="_blank" rel="noopener noreferrer">
<div className="pattern-content">
<h3>PHP SDK API</h3>
<p>Complete PHP SDK API documentation with all namespaces, classes, and interfaces.</p>
</div>
</a>

<a href="https://python.temporal.io/" className="pattern-card" target="_blank" rel="noopener noreferrer">
<div className="pattern-content">
<h3>Python SDK API</h3>
<p>Complete Python SDK API documentation with all modules, classes, and functions.</p>
</div>
</a>

<a href="https://ruby.temporal.io/" className="pattern-card" target="_blank" rel="noopener noreferrer">
<div className="pattern-content">
<h3>Ruby SDK API</h3>
<p>Complete Ruby SDK API documentation with all modules, classes, and methods.</p>
</div>
</a>

<a href="https://typescript.temporal.io" className="pattern-card" target="_blank" rel="noopener noreferrer">
<div className="pattern-content">
<h3>TypeScript SDK API</h3>
<p>Complete TypeScript SDK API documentation with all interfaces, types, and namespaces.</p>
</div>
</a>

<a href="https://dotnet.temporal.io/api/" className="pattern-card" target="_blank" rel="noopener noreferrer">
<div className="pattern-content">
<h3>.NET SDK API</h3>
<p>Complete .NET SDK API documentation with all namespaces, classes, and methods.</p>
</div>
</a>
</div>

## Server API References

<div className="pattern-grid">
<a href="/references/server-frontend-api-reference" className="pattern-card">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link seems to 404

<div className="pattern-content">
<h3>Server Frontend API</h3>
<p>gRPC API reference used by Client and Worker SDKs to communicate with Temporal Server.</p>
</div>
</a>
</div>

## Need Help?

For questions about specific APIs, use the **Ask AI** button in the top navigation for instant answers, connect our [Model Context Protocol server](/with-ai) to AI tools for real-time documentation access, or visit our [Community Forum](https://community.temporal.io/) and [Slack](https://temporal.io/slack) for community support.
7 changes: 1 addition & 6 deletions docs/references/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,12 @@ tags:
- Reference
---

- [API reference](/references/api-reference)
- [SDK metrics reference](/references/sdk-metrics)
- [Commands reference](/references/commands)
- [Events reference](/references/events)
- [Web UI environment variables reference](/references/web-ui-environment-variables)
- [Temporal Service configuration reference](/references/configuration)
- [Temporal Web UI configuration reference](/references/web-ui-configuration)
- [Temporal Cloud Operation reference](/references/operation-list)
- [Go SDK API reference](https://pkg.go.dev/go.temporal.io/sdk)
- [Java SDK API reference](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/index.html)
- [Python SDK API reference](https://python.temporal.io/)
- [TypeScript SDK API reference](https://typescript.temporal.io)
- [.NET SDK API reference](https://dotnet.temporal.io/api/)
- [PHP SDK API reference](https://php.temporal.io/namespaces/temporal.html)
- [Glossary](/glossary)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -609,6 +609,7 @@ module.exports = {
id: 'references/index',
},
items: [
'references/api-reference',
'references/cluster-metrics',
'references/commands',
'references/configuration',
Expand Down
Loading