Skip to content

Commit 7bf63c8

Browse files
runapi-builderrunapi-builder
committed
Initial Ideogram V3 API SDK release
0 parents  commit 7bf63c8

36 files changed

Lines changed: 2106 additions & 0 deletions

‎.github/workflows/ci.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
javascript:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-node@v4
13+
with:
14+
node-version: 20
15+
- run: npm install
16+
working-directory: js
17+
- run: npm test --if-present
18+
working-directory: js
19+
ruby:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: ruby/setup-ruby@v1
24+
with:
25+
ruby-version: '3.3'
26+
- run: |
27+
find lib -name '*.rb' -print0 | xargs -0 ruby -c
28+
working-directory: ruby
29+
go:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- uses: actions/setup-go@v5
34+
with:
35+
go-version: '1.26'
36+
- run: go test ./...
37+
working-directory: go

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Ideogram API SDK for RunAPI
2+
3+
The ideogram api SDK packages JavaScript, Ruby, and Go clients for Ideogram V3 on RunAPI. Use this ideogram api SDK for text-to-image, inpaint editing, and image remix workflows that need typed installs, JSON request bodies, task polling, and consistent RunAPI errors across services.
4+
5+
Ideogram V3 belongs to the Ideogram catalog on RunAPI. The public model page is https://runapi.ai/models/ideogram-v3; variant pages below carry pricing, rate-limit, and commercial-usage details. The public `ideogram-v3-sdk` repository groups the JavaScript, Ruby, and Go packages for this model.
6+
7+
## Install
8+
9+
```bash
10+
npm install @runapi.ai/ideogram-v3
11+
gem install runapi-ideogram_v3
12+
go get github.com/runapi-ai/ideogram-v3-sdk/go@latest
13+
```
14+
15+
## What you can build
16+
17+
- Build creative tools, agent pipelines, and production integrations with the ideogram api SDK.
18+
- Keep one model-specific repository while installing only the language package your app needs.
19+
- Use `create` for submit-only jobs, `get` for status lookup, and `run` for submit-and-poll scripts.
20+
- Handle authentication, validation, rate limits, insufficient credits, task failures, and polling timeouts through RunAPI SDK errors.
21+
22+
The JavaScript client exposes text to image, edit image, remix image resources, and the Ruby and Go packages mirror the same RunAPI task lifecycle.
23+
24+
## JavaScript quick start
25+
26+
```typescript
27+
import { IdeogramV3Client } from '@runapi.ai/ideogram-v3';
28+
29+
const client = new IdeogramV3Client();
30+
31+
const task = await client.textToImage.create({
32+
// Pass the Ideogram V3 request body documented at https://runapi.ai/docs#ideogram-v3.
33+
});
34+
35+
const status = await client.textToImage.get(task.id);
36+
```
37+
38+
For short scripts, use `run` with the same JSON body to create the task and wait for completion. For web request handlers, prefer `create` plus webhook or later `get` polling so the server does not hold a worker open.
39+
40+
## Repository layout
41+
42+
- `js/` publishes `@runapi.ai/ideogram-v3`.
43+
- `ruby/` publishes `runapi-ideogram_v3` when RubyGems publishing resumes.
44+
- `go/` publishes `github.com/runapi-ai/ideogram-v3-sdk/go` and depends on `github.com/runapi-ai/core-sdk/go`.
45+
46+
## Public links
47+
48+
- Model page: https://runapi.ai/models/ideogram-v3
49+
- SDK docs: https://runapi.ai/docs#sdk-ideogram-v3
50+
- Product docs: https://runapi.ai/docs#ideogram-v3
51+
- SDK repository: https://github.com/runapi-ai/ideogram-v3-sdk
52+
- Skill repository: https://github.com/runapi-ai/ideogram-v3
53+
- Provider comparison: https://runapi.ai/providers/ideogram
54+
- Full catalog: https://runapi.ai/models
55+
56+
## Pricing and variants
57+
58+
Use the most specific ideogram api variant page for pricing, rate limits, and commercial usage:
59+
- [Text to image](https://runapi.ai/models/ideogram-v3/text-to-image)
60+
- [Edit](https://runapi.ai/models/ideogram-v3/edit)
61+
- [Remix](https://runapi.ai/models/ideogram-v3/remix)
62+
63+
Default pricing link for the ideogram api SDK: https://runapi.ai/models/ideogram-v3/text-to-image
64+
65+
## FAQ
66+
67+
### Which package should I install for ideogram api work?
68+
69+
Install the model package for your language: `@runapi.ai/ideogram-v3`, `runapi-ideogram_v3`, or `github.com/runapi-ai/ideogram-v3-sdk/go`. Install core SDK packages only when you are building shared SDK infrastructure.
70+
71+
### Where should public links point?
72+
73+
Primary ideogram api links point to https://runapi.ai/models/ideogram-v3. Pricing and usage-policy links point to variant pages such as https://runapi.ai/models/ideogram-v3/text-to-image. Provider comparisons point to https://runapi.ai/providers/ideogram, and broad browsing points to https://runapi.ai/models.
74+
75+
## License
76+
77+
Licensed under the Apache License, Version 2.0.

‎go/README.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Ideogram API Go SDK for RunAPI
2+
3+
The ideogram api Go SDK is the language-specific package for Ideogram V3 on RunAPI. Use this ideogram api package for text-to-image, image-to-image, edit, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Go.
4+
5+
This ideogram api README is the Go package guide inside the public `ideogram-v3-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/ideogram-v3; for API reference, use https://runapi.ai/docs#ideogram-v3; for SDK docs, use https://runapi.ai/docs#sdk-ideogram-v3.
6+
7+
## Install
8+
9+
```bash
10+
go get github.com/runapi-ai/ideogram-v3-sdk/go@latest
11+
```
12+
13+
## Quick start
14+
15+
```go
16+
import (
17+
"context"
18+
19+
"github.com/runapi-ai/ideogram-v3-sdk/go/ideogramv3"
20+
)
21+
22+
client, err := ideogramv3.NewClient()
23+
task, err := client.Generations.Create(context.Background(), ideogramv3.GenerationParams{
24+
// Pass the Ideogram V3 JSON request body from https://runapi.ai/docs#ideogram-v3.
25+
})
26+
status, err := client.Generations.Get(context.Background(), task.ID)
27+
```
28+
29+
Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
30+
31+
## Language notes
32+
33+
Use the public Go module with `github.com/runapi-ai/core-sdk/go` options when building image services, CLIs, or workers. The available resources include generations, edits, and remixes. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
34+
35+
## Links
36+
37+
- Model page: https://runapi.ai/models/ideogram-v3
38+
- SDK docs: https://runapi.ai/docs#sdk-ideogram-v3
39+
- Product docs: https://runapi.ai/docs#ideogram-v3
40+
- Pricing and rate limits: https://runapi.ai/models/ideogram-v3/text-to-image
41+
- Provider comparison: https://runapi.ai/providers/ideogram
42+
- Full catalog: https://runapi.ai/models
43+
- Repository: https://github.com/runapi-ai/ideogram-v3-sdk
44+
45+
## License
46+
47+
Licensed under the Apache License, Version 2.0.

‎go/go.mod‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module github.com/runapi-ai/ideogram-v3-sdk/go
2+
3+
go 1.26
4+
5+
require github.com/runapi-ai/core-sdk/go v0.2.1

0 commit comments

Comments
 (0)